Technical Writing for a Life sciences and Chemistry enterprise product
Q3's global sourcing model gives the maximum benefit to customers in terms of cost savings, improved quality, access to highly talented professionals, flexibility of operations and reduced time to market.
Client is a leading supplier of discovery, collaboration, and knowledge enterprise solutions, desktop software, scientific databases and consulting services to the pharmaceutical, biotechnology, and chemical industries. The client's product, an “Electronic Lab Notebook”, facilitates daily record-keeping for scientists. This Electronic Notebook makes it possible to manage diverse types of data on electronic pages that are much like the pages of a paper notebook. It is an excellent tool to simplify the job of the analytical laboratory management team, the individual analyst, compliance authorities, and the customer; all at the same time. It has been designed to be user-friendly by utilizing such simple and widely used software tools like Microsoft Excel, Word and PowerPoint.
It helps create a customized electronic notebook that matches the user’s work- flow. Users can develop new fields to manage specialized types of data, and configure their own forms to manage the information that is important to them. They can also add their own data analysis tools and customized searches to the software.
It helps in organizing a wide variety of other information critical to other work processes as well. For example, common reactants used in reaction preps can be stored in the database and shared among researchers. In large enterprises, the software can be configured to both supply and retrieve information from other Enterprise systems, such as chemical registration or chemical inventory management systems.
The business requirement of the client was to develop a plan to design the technical content and provide its users with a documentation that helps/ guides them to understand the software and use all its features. The following documents associated with the software were to be provided to the users:
Technical writing was required for a product called ‘Electronic Lab Notebook’ which was intended for use in storing day-to-day reaction data by pharmaceutical and chemical synthesis industries.
Q3 developed a plan to manage the technical writing for the product from inception to completion. At the initiation level Q3 deployed domain experts with profound technical writing skills. Q3 constituted a Client Documentation team with a specified hierarchy to prepare the documentation of the software as requested by the client. Effective technical training on product features and functionalities were imparted internally to the team. Client requirements were mapped into well designed formats and designs to give best views on Word Doc, presentation and web files.
A strategy was devised to create the design help manuals using advanced tools such as Madcap Flare. Easy to follow steps and presentations for the client software were designed in a way that even novice users could easily follow and master them. Feedback and suggestions given by the client were incorporated on a regular basis. Daily reviews by peers were managed to get the quality standards on the technical content. User friendly documents helped client cover a large user base as the software could be used simply, by following the help manual. This in-turn helped the client get more orders and business opportunities.
Q3 accomplished in providing the following documentation for its client: