In order to “Learn to do by doing,” we must define the function of Technical Writers. Exactly what is the job of Technical Writers? Technical Writers translate complex information into clear, concise technical documents to be understood by others. To perform this function Technical Writers must learn certain techniques to create technical documents. The purpose of the webinar is to teach these techniques to budding Technical Writers so that they are not intimidated when confronted by a blank screen. A blank screen can be quite overwhelming to budding Technical Writers when they realize that someone expects them to fill that blank screen with Technical Documents during well-defined, often short timelines.

It is vitally important that Technical Writers identify the target audience. The target audience defines the goals of the written presentation. To determine the goals of the presentation Technical Writers should ask a few questions of the target audience. Who is going to read the technical documents? Why are they going to read them? What message are you, the Technical Writer, trying to convey to the audience? What do you, the Technical Writer, know about the target audience? How much do they know about the subject matter? What value can you, the Technical Writer, add to the knowledge of the target audience? If the target audience is well-versed in the subject matter, the scope of the technical documents will be completely different from if the target audience is unfamiliar with the subject matter.

Technical Writers must research the subject matter. Researching the subject matter leads directly to the issue of planning technical documents. The value of planning technical documents cannot be overstated. Planning technical documents may take as much as 50% of the allotted time.

To determine the objectives of the technical documents Technical Writers return to the target audience. What does the target audience want to know? How can Technical Writers satisfy that need? How many needs or requirements are necessary to address questions of the target audience?
Technical Writers must read and edit the technical documents they create before sending them for peer or supervisory review. The technical documents must be reviewed to ensure that they address the goals and objectives of the target audience. If the Technical Writers’ review indicates inconsistency with the goals or objectives of the target audience or with other parts of the technical documents the sections must be rewritten for consistency. There must be as many rewrites as necessary to achieve consistency.

Creating in-house templates is a common function of Technical Writers. Such templates are presented often as Standard Operation Procedures. Such Standard Operation Procedures are beneficial to organizations to ensure that company procedures are followed. They also ensure intra- and interdepartmental consistency and for training purposes.

All technical documents are subject to peer and/or supervisory review. Budding Technical Writers should not fear the review and approval process. The review and approval process can provide guidance on improving technical documents and new ideas and concepts to provide value to the target audience.