Overview
As a technical writing assignment, the Help Pages website is a documentation site with the following goals:
- Document application features and instruct users
- feature all EdaptIT’s generic features that may instruct any user
- feature client-specific features for client-specific users
- encourage discovery within the app instead of within Help Pages
- supply users with multiple options for learning across text, imagery, and video walk through.
- track technical vocabulary, supply definitions in context and summarized at the end of the article.
Process
The product development team for EdaptIT began by evaluating how the help pages would be used with the software. The high-level decisions included
- Direct links from EdaptIT screens to relevant document
- Multiple iterations of the documentation would exist per client as custom features may be added
- All documentation pages to include
- Table of Contents
- Keyword Definitions
- Glossary
- Screenshots
- Where applicable, video walk-through of concepts and features
- A section on how to access the EdaptIT screen
Spotlight
Here are a few pages from the helppages.us website: