14 Technical Writing Misconceptions That You Should Know!
14 Technical Writing Misconceptions That You Should Know! (Anuradha., 2017, February 25)
Myths in this Practitioner Blog Post:
- Technical writers simply write a user manual. It is called by various fancy names for different products
in Technical writers write only user manuals - Technical documentation is an insignificant part of product development
in Technical documentation is an insignificant part of product development - Racing against your product release deadline? Give technical documents a miss. No one reads them anyway
in No one reads technical docs - Documentation in English is sufficient. Everybody understands English
in Providing documentation in English is sufficient - It is enough to document key features of the product. Small things, the users can figure out themselves
in Only key features of the product need documentation - Product features must be listed in the documentation, in order of importance
in Product features must be listed in order of importance - Technical writers need a technical background and sound domain knowledge
in Technical writers need a technical background and sound domain knowledge - Technical writing is simply about listing product features, nothing creative about that
in Technical writing is not creative - Technical writing is simply about listing product features, nothing creative about that
in Technical writing is just listing product features - Good technical documentation requires use of several sophisticated tools
in Good technical documentation requires use of several sophisticated tools - Technical documentation is a writing intensive job
in Technical documentation is a writing intensive job - It is better to put all technical information about a product into one document, for easy reference
in It is better to put all technical information about a product into one document - It is better to omit information about any product limitations from technical documents
in It is better to omit information about any product limitations from technical documents - Software products are much the same as hardware products, as far as supporting technical documentation is concerned
in Software products are documented like hardware products - There is no career growth for a technical writer
in There is no career growth for a technical writer
Comments are not currently enabled on this site.