Q3 Technologies: Technical Documentation Services

Q3 Technologies, Gurgaon, India developed a Technical Documentation for ScopServ Telephony Server, which provides the communication solutions to business enterprises.

Business Situation:

The business requirement of the client was to develop a plan to design the technical content and provide its users with a documentation, which helps and guides them to understand the software and use all its features. The documents associated with the software are as follows:

• Admin Guide
• User Manual
• Quick Reference Guide
• Wiki (Online versions of Admin Guide and User Manual)

Documentation was required for ScopServ Telephony Server that was intended to provide the communication solutions to business enterprises. The ScopServ Telephony Server could be set as either a complete IP-PBX system or simply as a gateway to manage VoIP or PSTN (digital/analog) lines. Apart from this, the system provides world-class management GUI interface for managing the server and configuring users, extensions, and call features.

Solution:

Q3 Technologies developed a plan to manage the documentation for the product from inception to completion. At the initiation level, Q3 Technologies deployed domain experts with profound documentation skills. Q3 Technologies constituted a Client Documentation team 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 for providing best views on PDF documents and web files.

A strategy was devised to design and create help manuals using advanced tools such as Madcap Flare. Easy to follow steps 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 the client cover a large category of users as the software could be used easily by referring the manuals.