tech-doc-writer
SolidWrite, 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).
Install
Quality Score: 85/100
Skill Content
Details
- Author
- johnqtcg
- Repository
- johnqtcg/awesome-skills
- Created
- 6 months ago
- Last Updated
- yesterday
- Language
- Python
- License
- MIT
Integrates with
Similar Skills
Semantically similar based on skill content — not just same category
tech-writer
Write and edit technical documentation in a professional tone and grammar, 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.
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.
technical-writing
Write, reshape, translate or review product documentation — README, how-to, tutorial, reference, explanation, runbook, ADR/RFC and release notes — from its sources. Use the README module for repository presentation and an agreed house style. Skip ordinary messages and articles, code changes, commit records, agent instructions and standalone test runs.