Clear Technical Writing, Rhetoric, and Explanation

Classifications / Humanities And Philosophy / Clear Technical Writing, Rhetoric, and Explanation

TRACK

Turn technical knowledge into reader-centered explanations and durable documentation by choosing the right document shape, revealing mechanisms through concrete examples, writing for decisions and operations, and revising a maintained service docs pack.

How do I turn technical knowledge into a clear, trustworthy document that helps a specific reader understand, decide, act, or recover?

16 lessons

Continues to Nonfiction Voice, Observation, and Revision

LESSONS

1. 001
   Reader, Purpose, and the Promise of the Piece
   [TODO]
2. 002
   Documentation Types: Tutorial, How-To, Reference, and Explanation
   [TODO]
3. 003
   Lead With the Situation Before the Abstraction
   [TODO]
4. 004
   The Unit of Clarity: Sentence, Paragraph, Section
   [TODO]
5. 005
   Concrete Detail, Specific Nouns, and Useful Verbs
   [TODO]
6. 006
   Examples, Diagrams, and Small Models
   [TODO]
7. 007
   API and Reference Documentation: Paths, Schemas, Errors, and Edge Cases
   [TODO]
8. 008
   Review: Match the Document to the Reader's Job REVIEW
   [TODO]
9. 009
   Runbooks: Symptoms, Dashboards, Commands, and Rollback
   [TODO]
10. 010
    Postmortems and Decision Records
    [TODO]
11. 011
    Explaining Technical Work to Non-Specialists
    [TODO]
12. 012
    Documentation as Product Surface
    [TODO]
13. 013
    Docs Maintenance, Ownership, and Review Loops
    [TODO]
14. 014
    Writing to Learn and Writing to Decide
    [TODO]
15. 015
    Review: Revise Meaning, Shape, Style, and Proof REVIEW
    [TODO]
16. 016
    Capstone: Write a Service Docs Pack CAPSTONE
    [TODO]

← Back to Humanities And Philosophy