User help guide

I wrote a user help guide.

After studying DITA principles, I decided to test my knowledge by creating a user help guide where none currently exists.

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

This platform is quite basic, but it suited 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-based English company I’m currently working with 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 written by native English speakers.

Exhibit A: This PDF

My final version is, in fact, a draft, because I have created this independent of a team or subject matter expert. If this were more than a practice exercise, creating and maintaining user guides would be an iterative process.

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

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

Child pages of sub-topics have breadcrumb navigation at the bottom of the page.
Child pages of sub-topics (“Comments & Evaluations”) have breadcrumb navigation at the bottom of the page.
Each sub-topic page contains a list of all the other sub-topics within that section.
Each sub-topic page (“Logging In”) contains a list of all the other sub-topics within that section (“Using the Learning Management System”).
Each topic contains a table of contents that lists all the sub-topics.
Each topic (“Using the Learning Management System”) contains a table of contents that lists all the sub-topics.
Each sub-topic contains a "mini" table of contents.
Each sub-topic (“Monthly Reports”) contains a “mini” table of contents.
On this "Discussion Topics" page, the question categories expand and collapse using accordions.
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:

WordPress.com Logo

You are commenting using your WordPress.com 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.