Technical Writing - Nine Common Tech Writer Documents

"Writing is not like painting where you add. It is not what4. Product Descriptions and Specifications
you put on the canvas that the reader sees. Writing isProduct descriptions and specifications are documents
more like a sculpture where you remove; you eliminatethat describe the product on a detailed level. These
in order to make the work visible. Even those pagesdocuments could be a part of manuals and brochures.
you remove somehow remain."5. Executive Summaries
Elie Wiesel, 1928-, Rumanian-born American WriterThese are one page documents found in the beginning
"Technical writer" can sometimes be a very looselyof reports and business documents. It summarizes the
used term. This is especially true if you're working for adocument and gives the reader a high level overview
small or medium sized business.of what the rest of the document covers.
As tech writers, we're often under the impression that6. RFPs and RFQs
we'll only be creating manuals, processes, and productRequest for Proposal (RFP) and Request for
specifications. But if you're working for a small orQuotation (RFQ) are business documents that are
medium sized business, you could be asked to do a lotsubmitted to companies asking them to bid for
more than that.business.
Let's look at nine of the most common documents you7. Brochures
could be asked to create as a technical writer:Brochures are marketing documents which have one
1. Technical Manualspurpose - move the reader closer to a sale. For
Technical manuals are documents that present theexample - a brochure about a pest control service.
prescribed method of performing a task related to a8. Press Releases
specific tool or process either mechanical or electronic.Press releases give information about a product. Press
These documents are also called reference manualsreleases are marketing pieces masked in the form of
guides and installation or repair manuals/guides.news. There is a perception that news and press
2. User Manualsreleases are more credible than marketing documents.
User manuals are documents that provide instructionsSo companies use them to market their products.
for the use of a product. The principal difference9. Letters and Memos
between a technical and user manual is theAs a tech writer you are most likely to write letters
assumption that the user is not familiar with theand memos for mailings to a large number of people
operation of the product. The information is presentedeither within or outside the organization. Note: memos
based on this assumption so it may be on a moreare always meant for internal business communication.
elementary level than a technical manual. TheseWhen you're working as a full time tech writer, you
documents are also called user guides.may not create all these documents. But you should
3. Tutorialsbe aware of them. If you're planning on becoming a
A tutorial is a document that is related to a tutor orfreelance technical writer, knowledge of creating these
tutors. For example - course material on how todocuments can increase your client base.
perform tasks.