Notes:
• The chapters in this textbook were translated using OpenAI and may contain errors. If you find problems with the translations, please send corrections to the author at admin@mcmassociates.io.
• If you find obsolete or inaccurate technology here, you are also welcome to send corrections. However, remember that this is a book about technical writing, not a technology manual—older technologies can still provide useful examples.
• Donate to keep Online Technical Writing Textbook free.
• While you are here, send David a friendly hello email: admin@mcmassociates.io
A big change has come over this online technical writing book: it now uses technical document (techdoc for short) to refer to any document that contains tecnical information—as opposed to using report. The report is a subcategory along witb the other kinds of technical documents discussed in this book.
Introduction: Technical Writing
- What's new?
- About technical writing
- About technical-writing courses
- Resources
- About the author
- Acknowledgments
- Links to reference works
Applications of Technical Writing
Note: This online textbook now uses technical document, or just techdoc, in instances where report is too specific. (UN emblems) indicate translations are available if you take the link.
- Survey of techdocs
- Business and employment documents:
- Data reports
- Business plans
- Proposals
- Recommendation and feasibility reports
- White papers
- Progress reports
- Instructions
- Background reports
- Engineering design report
- Technology-oriented user guides
- Specifications and data sheets
- Release notes
- Use cases, case studies
- Standard operational policies and procedures
- Primary research reports. For lab and field.
- Literature reviews
- Guides and guidance documents
- Handbooks
- Front and back matter:
Information Structures
Information structures are used as parts of longer documents, but can be used as documents themselves, especially for technical-writing writing projects. These information structures are a good place to start for people in developmental technical writing.
Document Design
- Techdoc design overview
- Book design overview
- Page design overview
- Headings
- Lists
- Special notices
- Nontextuals: tables, figures, charts
- Techdoc format and final packaging
- Highlighting and emphasis
- Indexing
Processes and Guidelines in Technical Writing
- Writing process: from audience to rough draft
- Audience analysis
- Task analysis
- Translating technical information
- Power-revision techniques
- Information Processing
- Information collecting (NoodleTools or Notebook LM)
- Quotations, Paraphrases, Summaries: Phrasing, Punctuation, Attribution
- Basic patterns and elements of the sentence
- Common grammar, usage, punctuation problems
- Common spelling problems
- Strategies for peer-reviewing and team-writing
Examples, Cases & Models: Index
- Resumes
- Application letters
- Complaint letters
- Adjustment letters
- Inquiry letters
- Order letters
- Proposals
- Progress reports
- Instructions
- User guides
- Recommendation reports
- Data-analysis reports
- Technical reports (techdocs)
- Primary research reports
- Technical specifications
- Oral reports
- Report and section introductions
- Descriptions
- Comparisons
- Classification (Categorization)
- Causal narrative
- Definitions
- Process narrative
- Persuasion
