The client first engaged the ibruk technical writing team with improving existing user documentation. On seeing the quality of our work, after the first 4 months, the client completely outsourced the technical writing function to us. Then, for the next 5 years, our dedicated technical writing team created comprehensive user and technical documentation, marketing content, and training content.
The Client
The client provides data visualization solutions, both simple and complex, that users can use easily in web and mobile applications.
The Technical Writing Requirement
The client’s flagship product is a JavaScript charting library that includes over 100 charts, 1000 maps, and several ready-to-use dashboards that help visualize data for a number of business applications. The product also supports wrappers and plug-ins that let developers integrate the product with a platform of their choice.
The client approached ibruk Consulting to create exhaustive documentation that included user documentation such as how-tos, technical references, and API documentation. The user documentation was to be used by anyone who wanted to use the client’s data visualization solutions, while technical documentation was to be used by developers who would integrate the solutions into various business applications.
The Technical Writing Solution
The engagement started with ibruk Consulting identifying 2 technical writers with experience in JavaScript and software development. This was essential because they had to document code and create samples required for the documentation.
After the client trained this 2-member technical writing team on the solution, the team:
- worked on the solution to get hands-on experience
- defined the audiences for the solution and the documentation
- objectives for each category of target audience
- analyzed the existing documentation to identify areas of improvement and gaps
The first 4-months of the engagement was dedicated to restructuring the documentation while simultaneously updating it to meet the last major release. The technical writing team spent this time restructuring, rewriting, and updating the existing documentation by:
- defining writing guidelines and standards to ensure consistency
- defining processes that ensured the documentation process was disciplined and streamlined
- rewriting instructions to ensure they were complete and accurate
- adding contextual information that was missing
- deleting redundant and obsolete content
- incorporating examples and use cases to illustrate the power of analytics
Our deliverables included:
- API Guides
- User Guides
- Installation Guides
- Training Guides
The Continuing Engagement
After the 4-months, the client outsourced its technical writing function to ibruk Consulting and our scope of work has increased to incorporate:
- Marketing content such as product release announcements, articles, blogs, and press releases.
- Extensive business-focused, use case-based tutorials to help business users understand and leverage the capabilities of the data visualization solutions.
The Results
The client has benefitted from a technical writing team that:
- needs minimal handholding, and is capable of delivering quality technical and business content
- can be scaled to meet the documentation requirements
- is well-versed in industry best practices and suggests solutions that improve the quality of content and user experience
Want to know more? Do visit our technical writing services page and read other case studies focusing on our technical writing solutions.
Great and useful blog really helpful.
Technical Product Documentation Services