tech-doc-writer

Solid

Write, review, and improve technical documents (技术文档, 设计文档, 操作手册, 故障报告, API文档). Use when users ask to write/draft/review/improve a technical document, create an RFC/ADR, write a runbook or operation guide, produce API docs, or create any structured technical writing deliverable. Audience-aware, evidence-based, with quality gates, a mechanical linter, and staleness detection (age against review cadence, not merely a date field). Supports concept docs, task docs, reference docs, troubleshooting docs, and design docs (RFC/ADR).

AI & Automation 30 stars 5 forks Updated today MIT

Install

View on GitHub

Quality Score: 85/100

Stars 20%
50
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
80
License 10%
100
Description 5%
100

Skill Content

# Tech Doc Writer ## Quick Reference | If you need to… | Go to | |---|---| | Write a new document from scratch | §Execution Modes → Write + §Workflow (Phases 0→5) | | Review an existing document for quality | §Execution Modes → Review + §Quality Scorecard | | Improve / refactor an existing document | §Execution Modes → Improve (minimal-diff) | | Choose the right document type and template | §Gate 2: Classify Type and Audience + Load `references/templates.md` | | Write for a mixed audience (execs + engineers) | Load `references/writing-quality-guide.md` §Funnel Structure | | Include code examples or CLI commands | Load `references/writing-quality-guide.md` §Code Examples | | Find and fix common doc mistakes (12 anti-patterns) | Load `references/writing-quality-guide.md` §Anti-Examples | | Set up doc CI / PR templates / auto-generation | Load `references/docs-as-code.md` | ## Execution Modes ### Write (new document from scratch) - Full document generated from audience analysis and type classification. - Use templates from [templates.md](references/templates.md) as starting points. - Requires Phase 0–5 of the workflow. ### Review (evaluate existing document) - Read the full document first. - Classify its type, then run the Quality Scorecard. - Report findings grouped by severity (Critical / Major / Minor). - Provide concrete before/after fixes, not vague suggestions. ### Improve (refactor existing document) - Minimal-diff edits — change only what the scorecard flags; do...

Details

Author
johnqtcg
Repository
johnqtcg/awesome-skills
Created
6 months ago
Last Updated
today
Language
Python
License
MIT

Integrates with

Similar Skills

Semantically similar based on skill content — not just same category

Code & Development Listed

tech-writer

Write and edit technical documentation in a professional tone, following a fixed document structure (title, overview, prerequisites, steps, troubleshooting, next steps) and Microsoft Writing Style Guide markdown conventions. Use when writing, drafting, reviewing, or reformatting documentation, READMEs, guides, how-tos, tutorials, or API docs — even when the input is just rough notes with a request to "document this". Do NOT use for commit messages (use the commit skill), code comments, or non-markdown formats like Word or Confluence pages.

1 Updated 2 weeks ago
christiangalsterer
Code & Development Listed

tech-writer

Write or rewrite anything technical people write — READMEs, documentation pages, quickstarts, PRDs, tech specs, RFCs, ADRs, design docs, task breakdowns and task files, GitHub issues, bug reports, QA test plans, test cases, exploratory charters, verification reports, PR descriptions, code review comments, and async team updates — so it reads clearly, scans fast, stays faithful to source facts, and sounds human. Use when the user says "write a README", "improve these docs", "write a PRD", "write a tech spec", "draft an ADR", "break this into tasks", "write the task files", "open an issue", "write a test plan", "write test cases", "file a bug report", "write the QA report", "write the PR description", "draft a status update", or wants technical writing that persuades without marketing fluff. Do NOT use for marketing landing pages, sales copy, or ad copywriting.

2 Updated today
marcioaltoe
AI & Automation Featured

technical-writer

AI DevKit · Review and improve documentation for novice users. Use when users ask to review docs, improve documentation, audit README files, evaluate API docs, review guides, or improve technical writing.

1,623 Updated today
codeaholicguy