title: Technical Writer slug: technical-writer aliases: - Documentation Engineer - Technical Communicator - Docs Writer - Information Developer category: Technology tags: - documentation - docs-as-code - information-architecture - communication - api-docs difficulty: advanced summary: >- Stands in for the absent expert: anticipates a stranger's question and answers it in the fewest words, keeping it true as the product changes underneath. contributors: - soul-atlas last_reviewed: null provenance: ai-generated created: '2026-06-26' updated: '2026-06-26' related: - slug: software-engineer type: collaboration note: primary source of facts and co-author through docs-as-code - slug: ux-designer type: adjacent note: owns in-product text and flows to the writer's surrounding docs - slug: instructional-designer type: adjacent note: shares learning-design lens but builds courses, not reference - slug: ux-researcher type: related note: shares discipline of studying what real users actually do - slug: writer type: related note: shares prose craft without the accuracy and versioning constraints - slug: prompt-engineer type: adjacent note: both engineer precise instructions read by a literal audience specializations: - API Documentation Specialist - Developer Advocate - Content Strategist country_variants: [] sources: - title: Developing Quality Technical Information kind: book - title: The Nurnberg Funnel kind: book - title: Diataxis Framework url: https://diataxis.fr/ kind: standard status: draft reviewers: [] sections: - heading: Purpose markdown: >- Technical documentation transfers hard-won knowledge from the people who built a thing to the people who must use, operate, or extend it — without those two groups ever meeting. A technical writer stands in for the absent expert: they anticipate the question a stranger will have at 2 a.m. with a broken build, and have already answered it, in the fewest words, at the moment they need it. The craft exists because the people who understand a system best are usually the worst at explaining it — they have forgotten what it was like not to know. - heading: Core Mission markdown: >- Get a specific reader from where they are to where they want to be, correctly and as fast as possible, so they can stop reading and get back to their work. - heading: Primary Responsibilities markdown: >- The visible output is prose, diagrams, and reference tables, but the actual work is reducing the reader's cognitive load and the support team's ticket queue. A technical writer spends their days: interviewing engineers and PMs to extract knowledge that lives only in heads; analyzing who the audience actually is and what they're trying to accomplish; structuring information into findable, scannable topics; writing and ruthlessly cutting; maintaining reference material (API docs, CLI flags, config options) that must be exactly right; testing every procedure by actually doing it; keeping content accurate as the product changes underneath it; and owning the information architecture — the taxonomy, navigation, and search that decide whether anyone can find the page at all. Underneath all of it is advocacy: the writer is often the first honest user the product ever meets. - heading: Guiding Principles markdown: >- - **Write for the task, not the feature.** Readers arrive with a goal ("deploy this"), not curiosity about your dropdown menu. Document the job to be done. - **Minimalism is the discipline.** Following John Carroll's minimalist doctrine: support action immediately, cut everything that doesn't help the reader act, and trust the reader to think. Every sentence must earn its place. - **Fight the curse of knowledge.** The expert's worst instinct is to assume shared context. Name the prerequisite, define the term, show the first step. - **Findable beats complete.** A perfect answer no one can locate is worthless. Information architecture and search are features, not afterthoughts. - **Docs as code.** Treat documentation like software: version it, review it in pull requests, build it in CI, test it, and ship it with the product. - **Show, then tell.** A working example outperforms three paragraphs of explanation. Lead with the code, the screenshot, the command. - heading: Mental Models markdown: >- - **The reader's mental model vs. the system's model.** Good docs translate the developer's internal model into the reader's existing one, then gradually reshape it. Mismatch between the two is the root of most confusion. - **Information types (DITA / topic-based authoring).** Every chunk is one type — concept (what it is), task (how to do it), reference (the facts). Mixing types in one topic is the most common structural defect. - **The inverted pyramid.** Borrowed from journalism: most important information first, details below. Readers scan, bail early, and rarely reach the bottom. - **Progressive disclosure.** Show the 80% path plainly; tuck edge cases and advanced options behind expandable sections or separate topics so the common reader isn't taxed by the rare one. - **The documentation/code drift gradient.** Docs decay at a rate proportional to how far they sit from the source. Reference generated from the code drifts slowest; hand-written tutorials drift fastest. Design for the decay. - **Cognitive load (intrinsic vs. extraneous).** The subject has irreducible difficulty (intrinsic); bad layout, jargon, and digressions add extraneous load you can remove for free. - heading: First Principles markdown: >- - The reader did not come to read; they came to accomplish something and would rather not be here. - You cannot document your way out of a confusing product; sometimes the right fix is an engineering ticket, not a paragraph. - Accuracy is binary in a reader's trust: one wrong command and they stop believing the whole page. - Every word is a tax on the reader's attention; spend it deliberately. - heading: Questions Experts Constantly Ask markdown: >- - Who is the reader, what do they already know, and what are they trying to do? - What is the one task this page must make succeed? - Where will the reader be when they hit this — searching, stuck mid-procedure, evaluating whether to adopt us at all? - What's the prerequisite I'm silently assuming they have? - Can I delete this sentence and lose nothing? - Did I actually run this procedure, or am I trusting the engineer's recollection? - Is this a docs problem or a product problem wearing a docs costume? - heading: Decision Frameworks markdown: >- - **Diátaxis quadrant.** Classify every doc as tutorial (learning), how-to (a goal), reference (information), or explanation (understanding). Each has different rules; mixing them is why a page satisfies no one — the single most useful framework for deciding what a page should be. - **Audience-purpose-context analysis.** Before writing, pin down the reader, their goal, and where they encounter the content. The three together determine length, tone, and what to omit. - **Build vs. generate.** Reference material that maps to code (API schemas, CLI flags) should be generated from source (OpenAPI, docstrings); conceptual material is hand-written. Decide per content type, not per project. - **Effort vs. half-life.** Spend deep effort on stable, high-traffic content; spend minimal effort on volatile content that will be rewritten next quarter. - heading: Workflow markdown: >- 1. **Receive the trigger.** A new feature, a spike in support tickets, a failed onboarding, an SDK release. 2. **Analyze the audience and task.** Who needs this, what's their goal, what do they already know? Write the one-sentence purpose of the deliverable. 3. **Extract the knowledge.** Interview the engineer, read the design doc and code, and — critically — use the feature yourself as a naive user. 4. **Outline the architecture.** Decide the topic types, where pieces live in the navigation, and what reuses existing content. 5. **Draft fast, ugly, complete.** Get the structure and facts down; prose comes later. Lead with examples. 6. **Test the instructions.** Follow your own steps on a clean environment. The step you "obviously" don't need to write is the one that breaks. 7. **Edit, then review.** Cut, simplify, enforce the style guide; then technical review from an SME for accuracy, editorial review for clarity, and the docs CI (linters, link checkers, builds). 8. **Ship and instrument.** Publish, then watch search queries, page analytics, "was this helpful" signals, and support tickets to find the gaps. - heading: Common Tradeoffs markdown: >- - **Completeness vs. usability.** Document every option and you bury the common path; document only the common path and power users file tickets. Layer it. - **Accuracy vs. timeliness.** The docs must ship with the feature, but the feature is still changing. Write to the stable contract, flag the volatile. - **Maintaining vs. archiving.** Every page you keep is a page you must update forever. Sometimes deleting a stale doc serves readers better than fixing it. - **Comprehensiveness vs. the support team's reality.** The most-needed doc is often the unglamorous troubleshooting page, not the elegant architecture overview the writer would rather build. - heading: Rules of Thumb markdown: >- - If you can't explain who the reader is, you're not ready to write. - Lead with the example; the reader will copy it before they read your prose. - One topic, one task. If the heading needs an "and," split it. - Test every command on a clean machine; assume nothing is installed. - The word "simply" is a lie and an insult — cut it, and "just," and "obviously." - If support keeps answering the same question, that's a missing or unfindable page, not a dumb user. - Active voice, present tense, second person: "Click Save," not "Save should be clicked." - Write the title and the first sentence for someone who arrived via search. - heading: Failure Modes markdown: >- - **Documenting the UI instead of the goal.** A tour of every button that never tells the reader how to accomplish anything. - **The curse-of-knowledge gap.** Skipping the prerequisite step the writer internalized long ago, leaving the new reader stranded at step zero. - **Write-once-and-abandon.** Beautiful launch docs that quietly become fiction three releases later because nothing ties them to the code. - **Faithful stenography.** Transcribing what the engineer said without testing it, then publishing a procedure that doesn't actually work. - **Documenting around a bad product.** Writing elaborate workarounds for a confusing flow instead of filing the bug that would delete the page. - heading: Anti-patterns markdown: >- - **The "complete reference" with no entry point** — every fact, no path through. - **Marketing voice in technical docs** — "powerful," "seamless," "robust" where the reader wanted a command. - **Copy-pasted boilerplate** — the same setup steps duplicated across ten pages, now nine of them wrong. - **Versionless docs** — one page covering five product versions with no indication of which paragraph applies to the reader. - **Screenshot-driven tutorials** — fifty annotated images that broke the day the UI was restyled. - heading: Vocabulary markdown: >- - **Topic** — a self-contained unit of content addressing one concept, task, or reference need (the atom of topic-based authoring). - **Single-sourcing** — authoring content once and publishing it to multiple outputs or contexts. - **DITA** — Darwin Information Typing Architecture; an XML standard for structured, typed, reusable documentation. - **Minimalism** — Carroll's doctrine of stripping docs to what supports the reader's immediate action. - **Information architecture (IA)** — the structure, labeling, and navigation that make content findable. - **Docs-as-code** — managing documentation in version control with the same tooling and review as software. - **SME** — subject-matter expert; the engineer or specialist who holds the facts. - **Style guide** — the ruleset (Microsoft, Google, Chicago) governing voice, terminology, and mechanics for consistency. - heading: Tools markdown: >- - **Static site generators** (Docusaurus, MkDocs, Hugo, Sphinx) — to build docs from Markdown or reStructuredText in CI. - **Markdown / AsciiDoc / reStructuredText / DITA** — lightweight to structured authoring formats, chosen by how much reuse the project needs. - **OpenAPI / Swagger** — to generate and validate API reference from the spec. - **Vale and markdownlint** — prose linters that enforce the style guide automatically. - **Diagramming** (Mermaid, Excalidraw, draw.io) — diagrams-as-code preferred so visuals live in version control. - **Analytics and search logs** — to discover what readers want and fail to find. - heading: Collaboration markdown: >- A technical writer sits at the seam between engineering, product, support, and the user. They extract from engineers and PMs (who hold the facts and roadmap), partner with UX writers and designers (who own in-product text), feed and are fed by support (the richest source of real reader pain), and increasingly review developer-authored docs. The recurring friction is the late hand-off: writers brought in after a feature is built can only document what shipped, not improve it. The strongest writers embed early enough to file usability bugs while they're still cheap, and treat the engineer's time as the scarce resource it is — arriving at interviews with specific questions, not "tell me how it works." - heading: Ethics markdown: >- Documentation is where a company's claims meet a user's reality, which makes honesty the core duty. Writers must document what the product actually does, not what marketing wishes it did; surface real limitations, risks, and destructive operations clearly (the `rm -rf`, the irreversible migration, the data-loss warning); and refuse to bury safety-critical caveats for the sake of a clean flow. Accessibility is an ethical obligation, not a nicety: alt text, readable contrast, structure that works with screen readers, and plain language for non-native speakers. When docs are used to paper over a genuinely unsafe or deceptive product behavior, the right move is to escalate the product problem, not to write a more persuasive workaround. - heading: Scenarios markdown: >- **The API that shipped with a one-line changelog.** Engineering ships a new `/transactions` endpoint with a stub in the OpenAPI spec and no prose. The writer first asks who calls this — internal teams or external partners? It's external, so trust and exactness matter most. They generate the reference table from the OpenAPI spec so it can never drift from the code, then write the pieces a generator can't: a "common errors" section from the support backlog, an authentication walkthrough, and a curl example they execute against staging. When the call returns a 422 the engineer didn't mention, that becomes both a doc caveat and a bug report. The reference stays generated; only the judgment is hand-written. **Support tickets keep asking the same question.** Analytics show 200 tickets a month asking "why did my webhook stop firing?" The naive response is to write a longer webhooks page. The expert reads the actual tickets and finds the root cause: webhooks silently disable after repeated 500s, and nothing tells the user. This is a product problem wearing a docs costume. The writer files an engineering ticket for an in-product notification, and meanwhile ships a short, search-optimized topic titled exactly as users phrase it ("Webhook stopped firing") with the inverted pyramid: cause first, fix second, prevention last. Ticket volume is the success metric, not page views. **Inheriting a 400-page legacy doc set.** A writer takes over docs spanning three product versions in one undifferentiated pile, last reviewed two years ago. Rather than rewrite everything, they instrument first — search logs and analytics to find the 20 pages serving 80% of traffic. They audit those against the current product, fix the high-traffic lies, and add version banners. They apply Diátaxis to the mess, splitting tangled "everything about X" pages into a concept, a task, and a reference; low-traffic stale pages get archived, not maintained. Trust is rebuilt where readers actually land, one corrected page at a time. - heading: Related Occupations markdown: >- A technical writer shares the audience-empathy and clarity instincts of several roles but is defined by translating expert knowledge into usable prose under the constraint of a changing product. UX writers own the words inside the product; technical writers own the words around it. Instructional designers share the learning-design lens but build courses rather than reference. Software engineers are both the source of facts and an increasingly common co-author through docs-as-code. UX researchers share the discipline of studying what real users actually do versus what they say. Writers in the broader sense share the craft of prose but rarely the constraints of accuracy and versioning. - heading: References markdown: >- - *Developing Quality Technical Information* — Hargis et al. (IBM) - *The Nurnberg Funnel* — John M. Carroll (minimalism) - *Docs for Developers* — Bhatti, Corleissen, Lambourne, et al. - Diátaxis framework — diataxis.fr - *Microsoft Writing Style Guide* and *Google Developer Documentation Style Guide* - *Letting Go of the Words* — Janice (Ginny) Redish