Skip to content

References: Technical Writing

← Back to chapter

  1. Technical Writing - Wikipedia. Comprehensive overview of technical writing as a discipline, covering document types, audience analysis, style conventions, and the role of technical writers in engineering and software organizations.

  2. Software Documentation - Wikipedia. Covers the full spectrum of software documentation including requirements specifications, architecture documents, API references, user guides, and inline code comments.

  3. Style Guide - Wikipedia. Explains the purpose and structure of style guides for maintaining consistency in technical documents, from organizational style guides to industry standards like the Microsoft Writing Style Guide.

  4. Markel, Mike and Stuart A. Selber. Technical Communication. 13th edition, Bedford/St. Martin's, 2021. A widely adopted textbook covering the complete technical writing process from planning through revision, with emphasis on audience analysis, document design, and ethical communication.

  5. VanAlstyne, Judith S. and Timmerman, John E. Smart Brevity: The Power of Saying More with Less. Workman Publishing, 2022. Introduces the Smart Brevity framework developed at Axios for writing concise, scannable communications that respect reader time while delivering maximum impact.

  6. Google Technical Writing Courses - Google Developers. Free self-paced courses covering technical writing fundamentals including active voice, clear sentences, short paragraphs, lists, and document organization for engineering audiences.

  7. Write the Docs - Documentation Guide - Write the Docs. A community-maintained guide to documentation best practices covering tools, workflows, content strategy, and the documentation-as-code approach used in modern software teams.

  8. Microsoft Writing Style Guide - Microsoft. A comprehensive, publicly available style guide demonstrating industry-standard conventions for technical content including terminology, formatting, accessibility, and global-ready writing.

  9. Diátaxis Documentation Framework - Daniele Procida. A systematic framework for organizing technical documentation into four types -- tutorials, how-to guides, technical reference, and explanation -- based on user needs and learning modes.

  10. API Documentation Best Practices - SmartBear/Swagger. Practical guide to writing effective API documentation covering endpoint descriptions, request/response examples, error handling, and authentication guides for developer audiences.