This document doubles as both a general documentation instructions resource and, yes, the actual document template itself. Here’s what you do:

Save this document as “user guide instructions.”

Open this document and save as the name of your module followed by “instructions.” For example: “point mapping instructions.docx”

Get to documenting.

Styles You’ll Need

Access them from the styles menu or styles pane.

Heading 2

Body Text (Style Tag)

Heading 3

Body Text (Style Tag)

Instruction Numbering (Style Tag)

Instruction Numbering (Style Tag)

Instruction Numbering (Style Tag)

Bulleted List (Style Tag)

Bulleted List (Style Tag)

Bulleted List (Style Tag)

Note: (Style Tag)

The following list some general instructions / conventions to keep in mind as you document your modules. Do the best you can to adhere to them, but don’t worry about. It can all be fixed later. Also, if you have any questions or whatever, just stop by.

Usage

Heading Tags: Don’t use the Heading 1 tag. It is reserved for the app name in the hierarchy (i.e., Resolute Synergy).

Heading 2 Tag: Is intended for section titles. For instance, “User Management.”

Heading 3 Tag: Is intended for sub-sections. For instance, “Inviting A User.”

Note: Don’t use any Heading tag beyond Heading 3. In other words, no sub-section should have a sub-section. Sub-sub sections suck. If you find yourself in need of adding a second sub-section, consider chunking the content differently.

Instruction Numbering Tag: Use for steps. When using this tag, numbering may continue sequentially even after you inserted a new Heading tag. Something like this:

If this happens to you, right click somewhere in the numbered list and in the menu click Restart Numbering.

Bulleted List Tag: Yep, use for lists.

Body Text Tag: Do I have to say it? Fine. Use for text.

Note Tag: Use for important information that may not fit in within the structure of a series of steps or something you want to call out. Start each note with Note:

Conventions

When referencing a button, bracket and capitalize the button name. For example: Click the [Invite New User] button.

When referencing actual text found in the app such as menu names/items or other Resolute communications such as an email, encase the text n quote marks. For example: Click “Log Out” in the dropdown menu.

When referencing a screen or other element in the app, italicize and capitalize the name. For example: On the Account Management screen, complete the Credit Card Information form.

Pagination

Don’t worry about it. We’ll take care of it later. You are all about content.

Screenshots

People like pictures. For some, that’s how they learn best. Add screenshots you think are necessary to help readers better understand the content. Just add the graphics where they need to go. Don’t add any arrows, etc. We’ll style them later.

Other Graphics

If there are other graphics you want to add to help explain the content, go for it. If you have the graphical skills, do your thing. If not, let us know and we’ll land a hand.