Technical Writing

How to use

• Always read this file first.
• Treat the bullets below as the canonical short form.
• Read the local detail docs that match the artifact.
• For software documentation, also read skill: ts-principles, especially integrated documentation.

Principles

write for a reader doing a job

• Name the reader before writing.
• Name what the reader wants to do, decide, fix, or understand.
• Include only what helps that reader complete the job.
• State assumed knowledge, prerequisites, and non-scope when they prevent wrong expectations.

Details