technical-writer

Generates API references, developer guides, and Docusaurus documentation sites from project artifacts.

176|49|Updated Mar 4, 2026
One-click install
npx skills add https://github.com/nagisanzenin/production-grade --skill technical-writer-nagisanzenin
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: technical-writer
Source: https://github.com/nagisanzenin/production-grade/tree/main/skills/technical-writer
Command: npx skills add https://github.com/nagisanzenin/production-grade --skill technical-writer-nagisanzenin

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Projects accumulate code, specs, and infrastructure faster than documentation, leaving new developers unable to onboard and API consumers unable to integrate without reading source code. This Skill audits existing artifacts and produces a complete, source-grounded documentation set. ## Core Features & Use Cases - Content Audit and Gap Analysis: Inventories every project artifact, cross-references against a documentation matrix, and produces a prioritized writing plan. - API Reference Generation: Builds authentication guides, per-endpoint pages, error code tables, rate limiting docs, and webhook docs from OpenAPI/AsyncAPI specs with working code examples in multiple languages. - Developer Guides and Site Scaffold: Writes quickstart, local development, testing, contributing, and deployment guides, then scaffolds a Docusaurus site with sidebar navigation, search, versioning, and CI deployment. - Use Case: After finishing a backend implementation, run this Skill to produce a full docs/ tree — quickstart that works in under 10 minutes, complete API reference, and a deployable Docusaurus site with a docs-build CI pipeline. ## Quick Start Ask the agent to generate complete project documentation from the existing OpenAPI specs, architecture docs, and source code, including a Docusaurus site.

Frequently Asked Questions about technical-writer

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

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

Point the Skill at your api/openapi/*.yaml files and it generates per-endpoint reference pages, an authentication guide, error code tables, and rate limiting docs. It also produces a Redoc standalone HTML file and a downloadable openapi.json for consumers.

How to set up a Docusaurus documentation site with CI deployment?▼

Phase 4 scaffolds a Docusaurus 3.x project with docusaurus.config.js, sidebars.js, custom CSS, and a landing page, plus a GitHub Actions workflow that builds the docs, checks broken links, and deploys to GitHub Pages. Vercel and Netlify configs are available as alternatives.

Does it support brownfield projects with existing documentation?▼

Yes. In brownfield mode it reads existing docs first, matches the established style such as JSDoc or an existing docs site, and never overwrites existing README, CONTRIBUTING, or API documentation. The content audit phase identifies gaps rather than duplicating coverage.

What happens when source information is missing for a doc section?▼

The Skill never fabricates content. Missing information gets a TODO placeholder comment noting the source was not found and which team to verify with, and missing P0 source artifacts are flagged as blockers in the documentation plan.

Can it document webhooks and AsyncAPI event-driven APIs?▼

Yes. When AsyncAPI specs or webhook implementations exist, it generates webhook documentation covering event tables, payload examples, signature verification code in Python, JavaScript, and Go, retry policies, and local testing with ngrok.