skills.rest
sundarshahi
sundarshahiCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

technical-writer

Generates API references, developer guides, and Docusaurus documentation sites from OpenAPI specs and code.

1|Updated Jun 24, 2026
Search Tags:#documentation#openapi#technical writing#api reference#Docusaurus#CI gates#developer guides
One-click install
npx skills add https://github.com/sundarshahi/drydock --skill technical-writer-sundarshahi
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: technical-writer
Source: https://github.com/sundarshahi/drydock/tree/main/skills/technical-writer
Command: npx skills add https://github.com/sundarshahi/drydock --skill technical-writer-sundarshahi

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Keeping project documentation accurate and complete is hard: error tables drift from runtime code, quickstarts break, and API references fall out of sync with the spec. This Skill generates documentation directly from machine-readable sources (OpenAPI specs, error catalogs, observability contracts) and wires CI gates that fail the build when docs drift. ## Core Features & Use Cases - Source-generated API reference: Builds endpoint pages, authentication guides, and error-code tables generated from the error-catalog module and OpenAPI specs, with a runnable Bruno or .http API collection derived from the same spec. - Developer onboarding guides: Produces quickstart, local development, testing, contributing, architecture overview, and operations guides grounded in actual project artifacts, plus governance files (README, CONTRIBUTING, SECURITY, CODEOWNERS, changelog automation). - Docusaurus site with CI gates: Scaffolds a Docusaurus documentation site with sidebar navigation, search, versioning, and a docs-build workflow enforcing drift checks, broken-link validation, and OpenAPI validation. - Use Case: After your backend team ships a new API, run this Skill to regenerate the error-code reference from the error catalog, produce a runnable API collection from the OpenAPI spec, and publish an updated docs site — with CI failing if anyone hand-edits the generated files. ## Quick Start Ask the drydock orchestrator to route to the technical-writer skill to generate full project documentation from your OpenAPI specs and source code.

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?▼

This Skill reads api/openapi/*.yaml files and generates endpoint reference pages, authentication guides, and a runnable Bruno or .http API collection. A checked-in generator script re-derives these artifacts in CI so they cannot drift from the spec.

How to keep error code documentation in sync with code?▼

The error-code table is generated from the same error-catalog module the runtime error handler reads, via a gen-error-docs script. A CI job re-runs the generator and fails the build on any git diff, so hand-edited docs are rejected.

Does it support Docusaurus documentation sites?▼

Yes, Phase 4 scaffolds a Docusaurus 3.x site with sidebar navigation matching the doc sitemap, Algolia or local search, versioning, and deployment configs for GitHub Pages, Vercel, or Netlify. The build enforces onBrokenLinks: 'throw'.

Can it document an existing brownfield codebase?▼

Yes, brownfield mode reads existing documentation first, matches the established doc style, and never overwrites existing README, CONTRIBUTING, or API docs. It extends what exists rather than replacing it.

What CI checks enforce documentation quality?▼

The docs-build workflow runs docs:gen-check for drift detection, OpenAPI spec validation, broken-link checks, a metric-name lint against the observability contract, and a budget-ref lint preventing hardcoded performance numbers. Failing gates block production-ready status.

What are the limitations of auto-generated API docs?▼

Auto-generated reference docs lack context about why to use an endpoint, workflows, and gotchas. The Skill treats generated references as a baseline and layers hand-written developer guides on top, inserting TODO placeholders rather than fabricating missing information.

Related Skills

Explore More Content & Communication Skills→
FerEscobarDevFerEscobarDev

architecture

Generates architecture documents, OpenAPI contracts, and milestone roadmaps from business requirements.

Community
Advanced
brainbrewlabsbrainbrewlabs
7

doc-publishing

Publishes documentation to GitHub Pages, Vercel, or Netlify from source docs and build outputs.

Official
Intermediate
carayacaraya
1

code-example-validation

Validate code examples in documentation for correctness and safety.

Community
Intermediate
newkayak12newkayak12
1

code-documenter

Generate, format, and validate technical documentation including docstrings and OpenAPI specs.

Community
Intermediate