User Help Guide

My most recent personal project has been to complete a user help guide using DITA principles.

I created my guide using a free trial of ClickHelp, which I chose since it is browser-based, requiring no additional software or downloads.

This platform is a little bit basic, but I thought it was good for my purposes since I wanted to be able to practice user guide documentation while demonstrating my ability to write clearly and concisely.

I created documentation for InTouch Language Inc, the phone English company I work for part-time. Their existing training for teachers exists in discrete documents scattered across emails, videos, and various cloud drives. Not to mention, it’s not even written by native English speakers.

Screen Shot 2018-08-28 at 8.30.59 AM

Exhibit A: This PDF

Screen Shot 2018-08-28 at 8.44.22 AM.png

Exhibit B: This email and these videos

My final version is, in fact, a draft, because I have created this independent of a team or supervisor. In a real job setting, I understand that creating and maintaining user guides would be an iterative process.

However, working on this project made me happy. I would love to do more work like this in the future, especially with different platforms.

The guide now exists in Word doc format and HTML. Here are some screenshots from the HTML version, which I’ve hosted on Github.

Screen Shot 2018-08-28 at 9.18.34 AM

Child pages of sub-topics (“Comments & Evaluations”) have breadcrumb navigation at the bottom of the page.

Screen Shot 2018-08-28 at 9.19.00 AM

Each sub-topic page (“Logging In”) contains a list of all the other sub-topics within that section (“Using the Learning Management System”).

Screen Shot 2018-08-28 at 9.13.51 AM

Each topic (“Using the Learning Management System”) contains a table of contents that lists all the sub-topics.

Screen Shot 2018-08-28 at 9.12.40 AM

Each sub-topic (“Monthly Reports”) contains a “mini” table of contents.

Screen Shot 2018-08-28 at 9.15.16 AM

On this “Discussion Topics” page, the question categories expand and collapse.

Go to the full user help guide

Leave a Reply

Fill in your details below or click an icon to log in: Logo

You are commenting using your account. Log Out /  Change )

Google photo

You are commenting using your Google account. Log Out /  Change )

Twitter picture

You are commenting using your Twitter account. Log Out /  Change )

Facebook photo

You are commenting using your Facebook account. Log Out /  Change )

Connecting to %s

This site uses Akismet to reduce spam. Learn how your comment data is processed.