JobCannon
เชฌเชงเชพ เช•เซŒเชถเชฒเซเชฏเซ‹

Documentation Writing

โฌข เชŸเชฟเชฏเชฐ 3เชธเซ‹เชซเซเชŸ เชธเซเช•เชฟเชฒเซเชธ
เชฎเชงเซเชฏเชฎ
เชชเช—เชพเชฐ เชชเชฐ เช…เชธเชฐ
4 เชฎเชนเชฟเชจเชพ
เชถเซ€เช–เชตเชพเชจเซ‹ เชธเชฎเชฏ
เชฎเชงเซเชฏเชฎ
เชฎเซเชถเซเช•เซ‡เชฒเซ€
4
เช•เชฐเชฟเชฏเชฐ
เชเช• เชจเชœเชฐเชฎเชพเช‚

Documentation Writing is the discipline of creating clear, discoverable internal docs (READMEs, ADRs, runbooks, design docs, RFCs) that scale team knowledge and reduce onboarding time. Distinct from technical-writing (external copywriting). Career path: Junior (README+comments, $80-110k) โ†’ Mid (ADRs+design docs, $110-150k) โ†’ Senior (doc systems+style guides, $150-200k+). Built on clarity (Diรกtaxis framework: tutorials/howtos/reference/explanation), tools (Notion, Confluence, GitBook, Docusaurus, Backstage TechDocs), and doc-as-code practices (Git, CI/CD, auto-generated from code).

Documentation Writing เชถเซเช‚ เช›เซ‡

Write clear docs: API docs, architecture diagrams, runbooks, READMEs. Make knowledge accessible, reduce "tribal knowledge." Underrated career multiplier. Learning Curve: Medium (clarity + empathy for readers)

๐Ÿ”ง เชŸเซ‚เชฒเซเชธ เช…เชจเซ‡ เช‡เช•เซ‹เชธเชฟเชธเซเชŸเชฎ
NotionConfluenceGitBookDocusaurusMintlifyMkDocsHugoMermaidExcalidrawdraw.ioAsciidoctorRead the DocsBackstage TechDocs

๐Ÿ“‹ เชคเชฎเซ‡ เชถเชฐเซ‚ เช•เชฐเซ‹ เชคเซ‡ เชชเชนเซ‡เชฒเชพเช‚

Communication

๐Ÿ’ฐ เชชเซเชฐเชฆเซ‡เชถ เชชเซเชฐเชฎเชพเชฃเซ‡ เชชเช—เชพเชฐ

เชชเซเชฐเชฆเซ‡เชถเชœเซเชจเชฟเชฏเชฐเชฎเชงเซเชฏเชฎเชธเชฟเชจเชฟเชฏเชฐ
USA$90k$135k$185k
UKยฃ50kยฃ80kยฃ115k
EUโ‚ฌ55kโ‚ฌ85kโ‚ฌ120k
CANADAC$95kC$140kC$190k

๐ŸŽ“ เชชเซเชฐเชฎเชพเชฃเชชเชคเซเชฐเซ‹

Google Technical Writing FundamentalsWrite the Docs EssentialsDiรกtaxis Framework Certification

๐ŸŽฏ Documentation Writing เชจเซ‹ เช‰เชชเชฏเซ‹เช— เช•เชฐเชคเซ€ เช•เชฐเชฟเชฏเชฐ

Business Analyst
Operations Manager
Project Manager
Technical Writer

โš– เชธเชพเชฅเซ‡ เชธเชฐเช–เชพเชฎเชฃเซ€ เช•เชฐเซ‹

Technical WritingCommunicationApi Documentation

โ“ FAQ

What is the Diรกtaxis framework and why does it matter for docs?
Diรกtaxis divides documentation into 4 types: Tutorials (learn-by-doing), How-to Guides (solve specific tasks), Reference (lookup facts), Explanation (understand concepts). Most orgs mix these and confuse readers ('is this a tutorial or reference?'). Applying Diรกtaxis = 50% reduction in help requests. Google, Stripe, Django use it. Start by categorizing existing docs, then restructure.
READMEs vs Runbooks vs ADRs, what goes where?
README: What this repo does, how to run it, install deps. Runbook: Step-by-step ops procedures (how to deploy, handle incidents, backups). ADR (Architecture Decision Record): Why we chose X over Y, trade-offs, date, author. RFC (Request for Comments): Proposal before implementation. Reference docs: API signatures, CLI flags. How-to: Achieve a specific goal. Categorize by intent, not random.
How do I prevent docs from getting stale?
Root cause: no owner. Fix: assign DRI per doc, auto-flag outdated docs (git commit date >6mo + no recent edits), store docs near code (same repo), auto-generate from code (docstrings, OpenAPI), include 'Last updated' in frontmatter, run doc-link-checker in CI/CD. Stripe's docs stay fresh because they own them as a product, not a side task.
AI-generated docs in 2026, what should I do?
LLMs excel at structural scaffolding (boilerplate READMEs, runbook templates, first drafts of API docs from code). Use them for: generating doc-as-code skeletons, writing first-pass explanations, examples. Don't use for: domain-specific decisions (ADRs, trade-off analysis), technical accuracy without review. Always review + edit. Tools like Mintlify auto-generate docs from docstrings; use them.
Style guides and consistency, how much do they matter?
Consistency > perfection. A style guide prevents: 'READMEs' vs 'Readme' vs 'readme', mixed tenses (past vs present), unexplained acronyms. Create one page (Google's is 84 pages, too much). Enforce via pre-commit hook (lint markdown, check heading hierarchy) and doc-review in PR. Automate what you can (linting, spell-check), automate what you can't by making a checklist.
How do I build a doc culture where engineers write?
Acceptance: great docs take time, so make it frictionless. Provide templates, linters, auto-generated skeletons. Include docs in definition-of-done, review docs in PR like code. Ship a style guide, 2-page max. Celebrate docs ('this README cut our onboarding from 2 weeks to 3 days'). Tie docs to IC leveling (staff engineers known for docs). Make writing docs a career move, not admin busywork.

เช–เชพเชคเชฐเซ€ เชจเชฅเซ€ เช•เซ‡ เช† เช•เซŒเชถเชฒเซเชฏ เชคเชฎเชพเชฐเชพ เชฎเชพเชŸเซ‡ เช›เซ‡?

เช•เชฐเชฟเชฏเชฐ เชฎเซ‡เชš เชŸเซ‡เชธเซเชŸ เช†เชชเซ‹ โ€” เช…เชฎเซ‡ เชฏเซ‹เช—เซเชฏ เชŸเซเชฐเซ‡เช•เซเชธ เชธเซ‚เชšเชตเซ€เชถเซเช‚.

เชฎเชพเชฐเชพ เชถเซเชฐเซ‡เชทเซเช -เชซเชฟเชŸ เช•เซŒเชถเชฒเซเชฏเซ‹ เชถเซ‹เชงเซ‹ โ†’

เชคเชฎเชพเชฐเซ‹ เช†เชฆเชฐเซเชถ เช•เชฐเชฟเชฏเชฐ เชชเชพเชฅ เชถเซ‹เชงเซ‹

2,521 เช•เชพเชฐเช•เชฟเชฐเซเชฆเซ€เช“เชฎเชพเช‚ เช•เซŒเชถเชฒเซเชฏ-เช†เชงเชพเชฐเชฟเชค เชฎเซ‡เชšเชฟเช‚เช—. เชฎเชซเชค.

เช•เชฐเชฟเชฏเชฐ เชฎเซ‡เชš เชŸเซ‡เชธเซเชŸ เช†เชชเซ‹ โ€” เชฎเชซเชค โ†’