Technical Writing is one of the disciplines in the field of Technical Communication. The goal of Technical Communication as well as Technical Writing is to create clear and organized content that helps users to achieve specific goals. As per the Society for Technical Communication (STC) the value of technical communicators is twofold:
- They make information more usable and accessible to those who need that information
- In doing so, they advance the goals of the companies or organizations that employ them
Let's apply that to software instructions for example.
Software instructions help users to:
- Be more self sufficient
- Be more successful
- Be more accepting of the software
Software instructions help companies with:
- Increased user acceptance
- Reduced Help Desk support
- Reduced cost
THE SEVEN C's OF TECHNICAL WRITING
The Seven C's of Technical Writing are the qualities that every technical document should have:
Clear ⇔ Concrete ⇔ Concise ⇔ Consistent ⇔ Coherent ⇔ Cohesive ⇔ Complete
One of the important aspects of technical writing is writing for your audience. Usability testing ensures that your documentation satisfies your audience's needs. The results of a usability survey will direct the next step in the revision of the documentation. It will likely go through several stages before its final release.