skills.rest
koala-man-64
koala-man-64COMMUNITY
Explore all skills by this author →
GitHub

technical-writer-dev-advocate

Generate evidence-backed documentation, API references, and release notes from source code and specs.

Updated Dec 20, 2025
Search Tags:#documentation#technical writing#release notes#quickstart#api reference#docs audit#developer enablement
One-click install
npx skills add https://github.com/koala-man-64/helpful-scripts --skill technical-writer-dev-advocate-koala-man-64
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: technical-writer-dev-advocate
Source: https://github.com/koala-man-64/helpful-scripts/tree/main/exports/codex-skills/repo-local/technical-writer-dev-advocate
Command: npx skills add https://github.com/koala-man-64/helpful-scripts --skill technical-writer-dev-advocate-koala-man-64

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes assets (resource) components.

What problem does it solve? Engineering teams often ship features without accurate, usable documentation, leading to support tickets and slow onboarding. This Skill turns source code, specs, and tests into PR-ready docs with verifiable evidence links, so every claim in the documentation is traceable to code. ## Core Features & Use Cases - Docs Generation from Code: Produces quickstarts, how-to guides, concept docs, and troubleshooting pages grounded in source code, specs, and tests, with explicit "Unverified" flags for anything that cannot be confirmed. - API Reference from Specs: Parses OpenAPI, GraphQL, or protobuf definitions into reference docs with request/response examples and error tables. - Release Notes & Docs Audits: Writes user-impact-framed release notes and migration guides, and audits existing docs for broken links, stale instructions, and missing prerequisites. - Use Case: After merging a new API feature, ask the Skill to generate a quickstart, an API reference from the OpenAPI spec, and a release notes entry, all delivered as a PR-ready change set with file-and-line evidence pointers. ## Quick Start Ask the assistant to generate a quickstart and how-to guide for a specific feature by pointing it at the relevant source files, tests, and spec in your repository.

Frequently Asked Questions about technical-writer-dev-advocate

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

FAQPage Schema
How do I generate API reference documentation from an OpenAPI spec?▼

Provide the OpenAPI, GraphQL, or protobuf spec plus the auth model, and the Skill parses endpoints, schemas, and error responses into reference docs. It includes happy-path and common-failure examples per critical endpoint, using the bundled api-endpoint template.

How to write release notes from commits and pull requests?▼

Supply the commits, PRs, version, and target audience, and the Skill produces release notes framed by user impact: what changed, who should care, and what to do now. Breaking changes, deprecations, and known issues are called out with evidence links.

What documentation formats and doc stacks are supported?▼

The Skill detects existing doc stacks such as MkDocs, Docusaurus, Sphinx, Azure DevOps Wiki, or internal wikis, and defaults to plain Markdown in the repo's existing docs structure when the stack is unknown. Bundled templates cover how-to, concept, troubleshooting, release notes, and API endpoint pages.

Can it audit existing documentation for accuracy and gaps?▼

Yes, the docs audit playbook scans doc folders for broken links, stale instructions, missing prerequisites, and untestable steps. It outputs a report with fixes grouped by severity: blockers, high-impact, and nice-to-have.

What happens when documentation claims cannot be verified against code?▼

Unverifiable content is explicitly labeled "Unverified / Needs confirmation" and a follow-up task is queued rather than guessing. Every other section must cite evidence such as source file paths with line numbers, specs, tests, or tool output.

Related Skills

Explore More Content & Communication Skills→
markmhendricksonmarkmhendrickson
27

run-feature-workflow

Execute a deterministic feature development workflow from configuration files and feature specifications.

Community
Advanced
VIPER-MetricsVIPER-Metrics
1

document-feature

Generates Word/PDF/HTML documents from templates and JSON data feeds.

Official
Advanced
MissTullyMissTully

health

Run quality tools to compute a weighted 0-10 code health score.

Community
Intermediate
binee108binee108

moai-docs-generation

Generate API references and guides from Python, TypeScript, and JavaScript code.

Community
Intermediate