skills.rest
johnqtcg
johnqtcgCOMMUNITY
Explore all skills by this author →
GitHub

tech-doc-writer

Generate and review technical documents using templates and quality gates.

29|5|Updated Mar 13, 2026
Search Tags:#documentation#review#RFC#runbook#write#technical-docs
One-click install
npx skills add https://github.com/johnqtcg/awesome-skills --skill tech-doc-writer-johnqtcg
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: tech-doc-writer
Source: https://github.com/johnqtcg/awesome-skills/tree/main/skills/tech-doc-writer
Command: npx skills add https://github.com/johnqtcg/awesome-skills --skill tech-doc-writer-johnqtcg

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

Teams often struggle to produce clear, consistent, and maintainable technical documents such as RFCs/ADRs, runbooks, API references, and design docs. This skill provides a structured approach to writing, reviewing, and improving technical content with audience-aware framing, quality gates, and governance.

Core Features & Use Cases

  • Generate new technical documents from audience analysis and templates
  • Review and improve existing documents with a minimal-diff approach
  • Produce RFC/ADR, runbooks, API docs, and design docs that are publish-ready

Quick Start

Provide a brief, audience-tailored document outline and let the AI generate the full draft.

Frequently Asked Questions about tech-doc-writer

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I write an RFC or ADR for an engineering team?▼

To write an RFC or ADR, provide a brief audience-tailored outline to generate a structured, publish-ready draft. The skill applies templates, quality gates, and metadata to ensure code-like quality for engineering governance artifacts.

What is the best way to review and improve existing technical documentation?▼

Reviewing existing technical documentation is best handled with a minimal-diff approach that improves clarity and structure. The skill enforces audience-aware framing and quality gates while preserving the original content.

Can I generate runbooks and API docs automatically from an outline?▼

Yes, you can generate runbooks and API docs automatically by providing a brief audience-tailored outline. The skill automates creation of structured, publish-ready deliverables for operations teams.

Does this technical documentation skill support audience analysis for different engineering roles?▼

Audience analysis for different engineering roles is supported through audience-aware framing. The skill tailors generated technical documents to specific stakeholders, ensuring software engineers and operations teams receive relevant context.

How do you ensure consistent quality and structure across multiple technical documents?▼

Consistent quality and structure across multiple technical documents are ensured through defined output contracts, quality gates, and regression tests. The skill enforces code-like standards and metadata governance for every generated artifact.

Related Skills

Explore More Content & Communication Skills→
yonggaoyonggao
1

markdown-to-pdf

Convert Markdown files into PDF presentations and documents using Marp.

Community
Advanced
YokhanYokhan

modify-api

Update API endpoint contracts, implementations, tests, and documentation.

Community
Advanced
DevelopersGlobalDevelopersGlobal
65

ci-cd-pipelines

Automate CI/CD pipelines with quality gates and deployment processes.

Official
Advanced
belokonmbelokonm
8

document-writer

Create templated ADR, RFC, and system design documentation.

Community
Advanced