Case Study :
Creating a User Manual for an Online Electronic Store
- Opportunity
Our client required a complete User Manual for an online electronic store.
- About the Project
The document required by the client would allow the reader to get familiar with
the various features of their software. It would clearly provide help for all the
menu items in the admin section of the site, and for all the tasks required by the
administrator to manage the store.
- Solution
The Pi Research Documentation team started working on this project with minimum
inputs from the users. Before starting off with the documentation process, the technical
writers reviewed the entire admin panel of the site. They understood all the functionalities
of each and every section thoroughly along with its objectives and relationship
with each other.
The user manual was highly graphical with re-sized screenshots of the online Admin
Panel. The instructional aspect of the user manual was designed to make it very
easy to follow. Helpful sections like TOC (Table of Content) were dynamically generated
for easy navigation within the document.
Dynamic linking helped make the user manual user friendly. The entire process of
development, review, edits and QA was done within a short time span.
The document was developed within a very short period and it was delivered after
thorough reviewing, editing and QA.
According to the client's requirement, the document was developed in three formats
- DOC, PDF and in WEB HELP format.
The WEB HELP was developed using Robohelp. Web help is very effective for the readers
who want to view the document through browsers like Internet Explorer, Mozilla Firefox,
etc.
Pi Research has already done multiple versions of this user manual to keep in step
with new changes in the application.
- Client Comments
“Can’t say enough about this provider. They succeeded where 2 other providers had
already failed. They worked quickly and accurately with very little direction. If
I ever need any documentation done again I know where to go. Thanks guys!”