Clear Technical Writing
Improve clarity and conciseness of technical documentation by product managers, developers and quality engineers. Those who are not technical writers by profession have to meet the challenge of writing quality documentation – with time constraints and topic complexities. Furthermore, non-standardized writing formats and styles can create inconsistency and confusion. When using a standardized approach and applying best-practice writing techniques, employees can produce organized, consistent, clear and concise technical documents and save time.
Who should participate
Product managers, product developers, quality engineers
- Design documents
- Engineering reports
- Functional requirements
- Product manuals
- Test plans and reports
- Technical articles and white papers
The training includes four key components
- Pre-work:Participants complete a questionnaire and submit a writing sample for review. The instructor reviews the sample and tailors course topics to emphasize and address the needs of each participant.
- Critiquing: TheInstructor provides feedback and suggestions for improvement of the writing samples.
- Webinar:The webinar is scheduled for 90 minutes on two consecutive days. The sessions are comprised of lecture, discussion and brief writing and workbook exercises.
- eLearning drills and testing:Participants complete three, 15-minute, self-paced drill modules. Each module includes a graded quiz for completion.
- Implement a writing process for efficient, effective technical documentation
- Target writing for both technical and non-technical audiences
- Synthesize ideas from multiple content contributors
- Improve style, clarity and being concise in technical documents
- Improve layout, flow and accessibility of content
- Reduced time for participants to write technical reports
- Increased clarity and consistency in report structure and style
- Improved accessibility and usability of content for report audience
- Improved efficiency in projects and operations due to increased effectiveness of technical documentation
- Plan the purpose and scope of documents
- Target content to the audience and purpose
- Ensure completeness of content
- Draft documents with speed
- Begin in a way that engages the reader
- Incorporate processes and procedures
- Hit the right style for technical documents
- Organize sections and paragraphs in a logical format
- Highlight the most important information
- Revise paragraphs and sentences for clarity and conciseness
- Demystify writing using plain English
- Eliminate jargon
- Avoid the nine most common technical writing errors
- Proofread for error-free writing