Online Technical Writing

by David McMurrey

Read here Read at LibreTextsPDF

The Online Technical Writing textbook offers a comprehensive guide to the essential skills and practices in technical writing. It covers various types of documents, including business correspondence, reports, proposals, user guides, and technical manuals, along with their design and formatting principles.

Description from LibreTexts.

Publisher
Austin Community College
Subjects
Humanities, Composition
Licence
CC BY 4.0, as LibreTexts states it
Who can read
Teens profiles and older, judged from its title and subjects

Contents

LibreTexts writes equations in TeX, and here they show as TeX; the PDF has them typeset.

  1. Front Matter
  2. TitlePage
  3. InfoPage
  4. Table of Contents
  5. Licensing
  6. 1: Introduction- Technical Writing
  7. 1.1: About technical writing
  8. 1.2: About technical-writing courses
  9. 1.3: Resources
  10. 1.4: About the author
  11. 1.5: Acknowledgments
  12. 2: Applications of Technical Writing
  13. 2.1: Business correspondence and resumes
  14. 2.1.1: Overview of business correspondence- format and style
  15. 2.1.2: Inquiry letters
  16. 2.1.3: Complaint and adjustment letters
  17. 2.1.4: Application letters
  18. 2.1.5: Resumes
  19. 2.2: Types of technical reports- an overview
  20. 2.3: Business plans
  21. 2.4: Proposals
  22. 2.5: Progress reports
  23. 2.6: Instructions
  24. 2.7: Technical reports
  25. 2.8: User guides
  26. 2.9: Standard operational policies and procedures
  27. 2.10: Recommendation and feasibility reports
  28. 2.11: Handbooks
  29. 2.12: Titles, abstracts, introductions, and conclusions
  30. 2.12.1: Titles
  31. 2.12.2: Abstracts
  32. 2.12.3: Introductions
  33. 2.12.4: Conclusions
  34. 2.13: Oral presentations
  35. 3: Document Design
  36. 3.1: Report design overview
  37. 3.2: Book design overview
  38. 3.3: Page design overview
  39. 3.4: Headings
  40. 3.5: Lists
  41. 3.6: Special notices
  42. 3.7: Tables, graphs, charts
  43. 3.8: Graphics
  44. 3.9: Report format and final packaging
  45. 3.10: Highlighting and emphasis
  46. 3.11: Indexing
  47. 4: Processes and Guidelines in Technical Writing
  48. 4.1: Writing process- from audience to rough draft
  49. 4.1.1: Topic ideas
  50. 4.1.2: Brainstorming and invention
  51. 4.1.3: Narrowing
  52. 4.1.4: Outlining
  53. 4.2: Audience analysis
  54. 4.3: Task analysis
  55. 4.4: Translating technical information
  56. 4.5: Power-revision techniques
  57. 4.6: Libraries, documentation, cross-referencing
  58. 4.6.1: Information Search
  59. 4.6.2: Citing Sources of Borrowed Information
  60. 4.6.3: Cross-Referencing
  61. 4.7: Information-collecting strategy
  62. 4.8: Quotations, Paraphrases, Summaries- Phrasing, Punctuation, Attribution
  63. 4.9: Basic patterns and elements of the sentence
  64. 4.10: Common grammar, usage, punctuation problems
  65. 4.11: Common spelling problems
  66. 4.12: Strategies for peer-reviewing and team-writing
  67. 4.13: Information structures
  68. 4.13.1: Description
  69. 4.13.2: Comparison
  70. 4.13.3: Classification (Categorization)
  71. 4.13.4: Cause–Effect
  72. 4.13.5: Definition
  73. 4.13.6: Process
  74. 4.13.7: Persuasion
  75. 5: Examples, Cases and Models- Index
  76. 5.1: Resumes
  77. 5.2: Application letters
  78. 5.3: Complaint letters
  79. 5.4: Adjustment letters
  80. 5.5: Inquiry letters
  81. 5.6: Order letters
  82. 5.7: Proposals
  83. 5.8: Progress reports
  84. 5.9: Instructions
  85. 5.10: User guides
  86. 5.11: Recommendation reports
  87. 5.12: Technical reports
  88. 5.13: Primary research reports
  89. 5.14: Technical specifications
  90. 5.15: Oral reports
  91. 5.16: Report and section introductions
  92. 5.17: Descriptions
  93. 5.18: Comparisons
  94. 5.19: Classification (Categorization)
  95. 5.20: Causal discussion
  96. 5.21: Definitions
  97. 5.22: Process discussion
  98. 5.23: Persuasion
  99. Back Matter
  100. Index
  101. Glossary
  102. Detailed Licensing
  103. Detailed Licensing