Case Study : User Manual for Content Management Software, USA
- Opportunity
To create a User Manual for a Web Content Management Solution.
- About the Project
The requirement was to create an intuitive User Manual for a web-based CMS developed on ASP.Net. The CMS had many modules and there was also a self-service aspect to it.
- Solution
Based on client requirements, the Pi team developed a Table of Contents (ToC) for the user manual. It included all the activities that could be performed with the application, and was developed on the following basic structure:
- Introduction
- Installing the software
- Using the software
- Administration
- Troubleshooting
- Appendix
According to client conditions, every page in the manual was split into two halves. On the left was a step by step guide, while the right half consisted of the relevant screenshots. Each separate module, like site manager, content manager, library, site access, and module manager, was described along with the respective screenshots. Extensive quality checks were performed to ensure accuracy.
The Pi team completed a comprehensive user guide and delivered the finished product within a very short time.
- Client Comments
“I hope to come back to your team for the next version soon.”