Tools used: FrameMaker.

Purpose: This project involved writing instructions for potential internal employees using Dolibarr ERP/CRM, an open source management software. I designed and formatted the user guide, and edited the content with feedback from a naive user.

User Guide

Download Sample

Identify the Users

I identified the audience, their problems, needs, and requirements to determine the scope of the content that will be covered in the user guide.

Map the User Journey

I mapped the journey my user will take to determine the appropriate amount of documentation needed, and the structure of said documentation.

Write Simple and Easy to Follow Content

I wrote instructional content, and use visuals that are simple, and easy to follow. Instructions should include essential elements needed to complete a task, and explain what users will see or hear.

User Testing and Revising

Then I tested the instructions alongside the product on naive users, and revise my content accordingly. Content should be accessible, and users should be able to follow instructions without additional support.

My Process

Successes

Identify target audience
- Identify audience, context, and purpose to determine requirements and approaches that best meets the user need for this document.
Follow best writing practices
- Write accurate and clear instructions, technical definitions, and procedures using the principles of plain language.
Integrate navigation features
- Table of contents, page numbers, cross-references, hyperlinks, glossary, and an index were integrated to quickly direct the reader to information they're trying to find.
Integrate useful graphics
- Relevant graphics, diagrams, figures, and tables were integrated into the document to highlight and illustrate important concepts.
Understand trademarks
- Copyright, patent and trademark laws were evaluated.
Perform usability testing
- Usability testing on a naïve user was performed to evaluate the effectiveness of the instructions.