The Write Choice’s Workflow explained
We know that choosing your first outsourced technical writing agency can be challenging. You might be struggling to build your documentation, and you still haven’t had enough time to study and select which supplier will suit your needs.
To clarify our process even before getting commercial, we wrote this article about how we think and work with all of our clients. An agile workflow that adapts to different technology companies and challenges, as we show in some of our case studies later in this post. Get deep into Write Choice’s Workflow now. Good read!
Our workflow begins when the client contacts us, or we step forward and call them after a hand raise. We usually schedule a meeting to understand their needs and the project itself. The first meeting is crucial to understanding the desired deliveries, the project scope, and the deadlines.
After defining all the aspects of the project, we send the client a proposal specifying the project’s costs and our subscription plans available. The proposal also includes all the steps, deliverables, and development timelines.
Once we get the proposal done, we already know the best Write Choice’s team to scale to work on that project. We consider the experience and the understanding of related solutions that can help the development of the project.
We can also help the clients choose their documentation platform because sometimes they need help to figure out which platform is best for their situation. We are pretty used to doing some research and presenting each solution’s benefits, pros, and cons to go through the next step and continue the workflow.
There are other two special cases that appear on this stage: companies that already have documentation and need to update the software they use, and the companies that do not have documentation yet and they don’t really know which softwares are available to use. We provide the same consultancy on listing the best solutions for both with their pros and cons.
After closing the project or subscribing to one of our planes the integration step starts. As a new part of the tech team, we must establish communication with the rest of the members to guarantee the information flow from day one. That is when we integrate into the client systems or define a new communication platform.
For example, if we connect via Slack, we can create a channel with them through Slack Connect to keep all the team members, both our team and their team, to guarantee a more effortless communication flow. We can also use Microsoft Teams, WhatsApp, or Telegram as they prefer. We must also ensure our access to the documentation platform to start working on it.
Before we start working on the documentation, the client’s team shares their business knowledge. That’s when they perform a deep presentation regarding their solution so that our team can create and provide a first draft for the documentation’s outline. We only start writing when the client revises and approves the suggestions.
We take collaborative development seriously. In the meeting, we discuss and analyze the documentation’s structure logic, always thinking about the user experience and how to reflect the real user journey into the documentation.
It is a tricky task because that usually is one of the issues that pushes the client into looking for specialized help. They frequently don’t understand what their user consumes in the documentation, so we need extra care when deciding what they need to present to their users. If the client has onboarding materials, we use them to define these users’ paths.
We also count on our experience developing several types of user documentation for different industries. With this know-how to structure proper documentation, we provide reports weekly or even daily through agile stand-up rituals or weekly meetings as we progress.
That’s the most efficient way to keep the client updated on the progress and the development of the process. Through this way of consistent reporting, we can address issues and challenges early in the process to make the project even more effective.
In these reports, we address the progress and the challenges we face. We always ask for help with points that aren’t clear for us to document the software. Sometimes, we find problems they weren’t aware of, which can be blocking their team’s work.
We also use these updates to ensure that the documentation reflects the software. Despite having an approved outline, sometimes it needs to change as we go deeper into this software. The more we learn, the more precise our overview of the solution gets, and sometimes, it makes us change the strategy by adding or removing some content because it turns out to be necessary.
When the documentation gets done, how do we keep it updated? If the client wants and subscribes to this subscription plan, our team can keep receiving software increments and improvements and ensure that the documentation gets the necessary updates.
When dealing with software documentation, as the software continues receiving updates, the documentation needs to keep up with it, and there are requirements for continued services in these cases. In addition, we can provide additional services, such as localization, as the company grows and expands to new markets.
We have been part of big companies through our high-quality technical writing services. They all have gone through the same workflow and got different results, crafted by their needs and directions along the process.
Sunsynk revolutionizes the way we generate, use, and store energy. With their solution, you can install your own solar storage system customized to your size and needs. Unlike most of our portfolio, Sunsynk requires a user manual for hardware.
We worked alongside the development team to understand the product, and then we wrote, designed, and edited this document. The company loved our work back then, and we still compound their outsourced technical writing lead team, developing product manuals, datasheets, brochures, and more.
Yuno is a worldwide payment orchestration company. You integrate once with Yuno and can access over 200 payment providers worldwide.
We had the opportunity to develop their API documentation in three languages (English, Portuguese, and Spanish). We teamed up with their development team via Slack and Zoom calls to understand the API.
We also created a portal for the documentation, with a well-designed landing page and a guides section.
Typhoon HIL, Inc. is the top ultra-high fidelity Hardware in the Loop (HIL) solutions provider for testing and validating power electronics, microgrids, e-mobility, EV powertrain software, and distribution control systems.
They wanted to showcase their HIL solution for electric mobility applications to reach new clients and strengthen their brand. We produced a brochure presenting how the company’s solutions can overcome several challenges in the development stage of EVs and charging stations.
Using our experience in writing content for the e-mobility industry and knowledge of control systems, we provided Typhoon with an outstanding brochure, considering all its brand colors, logos, and styling.
You can find technical writers and specialized agencies worldwide, but no one masters this workflow as we do in Write Choice. We aim to revolutionize how tech companies teach their products to customers through top-notch technical documentation and content.
We orchestrate a collaborative and highly skilled team in different contexts and cultures to build the best documentation for your business. We match empathetic and technical abilities to deliver efficiently and on size to your needs.
Want to revolutionize how your company communicates with your users? Choose right and take our workflow’s first step: schedule our first meeting. Just follow this link and talk to one of our specialists. Talk soon!
Write Choice Ltda Rua Jornalista Tito Carvalho 155, Florianópolis, Brazi
+55 46 99927-4442
© 2023, White Choice. Todos os direitos reservados.