--- name: technical-writing-fundamentals description: Write or revise technical documentation and explanations using clear, audience-focused language, useful structure, and sound sentence-level choices. --- # Technical Writing Fundamentals Use these principles when drafting or revising ordinary technical content. ## Workflow 1. Identify the reader, their task, prior knowledge, and what they should be able to do or understand afterward. Use context; ask only when a missing answer would materially change the writing. 2. State purpose and scope early. Organize around the reader's tasks or questions, with descriptive headings and prerequisites where useful. 3. Draft with familiar, precise words. Prefer concrete verbs, active voice when the actor matters, and concise sentences. Keep one main idea per paragraph. 4. Use numbered steps for sequences, bullets for unordered items, and tables only for compact comparisons or repeated properties. Label links by their destination or action. Format code and commands consistently. 5. Review for accuracy, missing steps, ambiguous terms, parallel structure, grammar, punctuation, and consistency. Preserve the author's meaning and technical claims; verify claims against available evidence instead of inventing details. Adapt advice to the target language. English-specific grammar guidance does not automatically apply elsewhere. Use [Technical Writing One](references/) for sentence-level fundamentals and [the course overview](references/technical-writing-overview.md) for source context. ## References - [Technical Writing One introduction](references/technical-writing-one-01.md) - [Grammar](references/technical-writing-one-02-just-enough-grammar.md), [words](references/technical-writing-one-03-words.md), and [active voice](references/technical-writing-one-04-active-voice.md) - [Clear sentences](references/technical-writing-one-05-clear-sentences.md), [short sentences](references/technical-writing-one-06-short-sentences.md), [lists and tables](references/technical-writing-one-07-lists-and-tables.md), and [paragraphs](references/technical-writing-one-08-paragraphs.md) - [Audience](references/technical-writing-one-09-audience.md), [documents](references/technical-writing-one-10-documents.md), [punctuation](references/technical-writing-one-11-punctuation.md), [Markdown](references/technical-writing-one-12-markdown.md), and [summary](references/technical-writing-one-13-summary.md) - [Course overview](references/technical-writing-overview.md) Source: [Google Technical Writing One](https://developers.google.com/tech-writing/one).