Keys to Good Technical Documentation

Write for Your Audience

Technical documentation is created for users that’s why the main purpose besides writing effective documentation is to learn your target audience. However, it can be challenging. Here are some tips how you can gather information about your audience:

  • Ask your support team. As technical writers closely work with other team members, you can interview your support team for this purpose. They clearly know what users don’t understand, this information will be helpful for creating the right questions.
  • Use Google Analytics. Google Analytics is a great tool for gathering information about your audience, it provides you with the potential clients age, location, interests and the like.

Format for Accessibility

Accessibility is another thing that you must pay attention to. Nowadays, devices, software, and technical documentation should be formatted according to accessibility rules. For software, there are two main guidelines — Section 508 and WCAG. For web content, you can follow WCAG recommendations, as well.

  • code or markup that defines the structure, presentation, etc.

Keep in Mind Your Goal

Writing documentation is not a goal itself, the purpose of any piece of documentation is to teach. When you think about your target audience, you also must consider what knowledge you wish the reader to leave with. Too much or too little information will confuse your readers.


SOURCEhttps://medium.com/technical-writing-is-easy/keys-to-good-technical-documentation-c139b583cc44

WRITTEN BY

Kesi Parker
Job position: Freelance Technical Writer. I use ClickHelp for technical writing.
Technical Writing is Easy

Technical Writing is Easy

Technical writing is for everyone!