Technical Writer

The journey

1. What you learn

   1. Understanding a system well enough to explain it honestly
   2. Documentation organised around tasks rather than around features
   3. Developer documentation where someone succeeds in their first five minutes
   4. Documentation kept true as the product keeps changing

2. What you will understand

   1. Documentation succeeds when the reader does, not when it is accurate
   2. Stale documentation is worse than none, because it is trusted
   3. The four documentation types, and why mixing them serves none of them
   4. The curse of knowledge, and writing against your own expertise

3. What you will build

   1. A developer documentation set with runnable examples that fail the build when broken
   2. A documentation test where a real reader succeeded and the success rate is reported honestly
4. 1. The proof you build

      Evidence that you can produce documentation people succeed with and keep it true as the product changes.

      See how proof works