User:Pavithraes/Sandbox/Technical writer guide

Overview
Effective technical documentation is a product of effective planning, production and presentation. This document aims to help technical writers.

Steps to writing technical documentation
 Define the context and purpose 

Clearly defining the purpose of the documentation will help you focus your ideas in the right direction. Outlining what topics the document should cover and what it shouldn't is an important part of this step. The best way to define a purpose is to have a clear problem statement that the document solves.

 Understand your audience 

Take a moment to think about who your intended readers are, what is their background, what is their level of expertise, etc. This will help you recognize the best way to deliver your content.

 Decide on a document genre 

Once the purpose and audience are sorted, decide on a doctype. See templates and suggestion.

 Collect content 

 Structure 

 Draft 

 Feedback and review 

Content collection strategy
A content collection strategy for technical documentation is gaining popularity because the users care more about the quality of documentation than the quantity of information, and the quality of documentation directly depends on the quality of content.