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 and anti-staleness enforcement. Supports concept docs, task docs, reference docs, troubleshooting docs, and design docs (RFC/ADR).

AI & Automation 27 stars 5 forks Updated yesterday MIT

Install

View on GitHub

Quality Score: 85/100

Stars 20%
48
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
4 months ago
Last Updated
yesterday
Language
Python
License
MIT

Integrates with

Similar Skills

Semantically similar based on skill content — not just same category