developer-documentation

Create and validate accurate developer documentation for software, APIs, CLIs, and operations.

75|5|Updated Aug 19, 2026
One-click install
npx skills add https://github.com/NateBJones-Projects/developer-documentation-skill --skill developer-documentation-natebjones-projects
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: developer-documentation
Source: https://github.com/NateBJones-Projects/developer-documentation-skill
Command: npx skills add https://github.com/NateBJones-Projects/developer-documentation-skill --skill developer-documentation-natebjones-projects

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve? Writing developer documentation that matches the actual system is slow and error-prone; docs drift from code, mix proposals with shipped behavior, and break links or structure. This Skill inspects the real code, tests, schemas, and interfaces before writing, then checks the finished Markdown with a bundled validator. ## Core Features & Use Cases - Behavior-grounded writing: Reads current code, tests, configuration, and command help before documenting, and labels anything that cannot be verified instead of inventing claims. - Full document-type coverage: Produces READMEs, quickstarts, tutorials, how-to guides, concept pages, API/SDK/CLI references, installation and migration guides, runbooks, release notes, and troubleshooting pages, each matched to the reader's job. - Bundled Markdown validator: A dependency-free Python script checks UTF-8 decoding, heading structure, fenced code blocks, local links, image alt text, and optional GitHub-style heading fragments. - Use Case: Ask it to build a documentation set for a CLI project; it inspects the command parser, writes an overview, quickstart, and CLI reference with verified commands, then runs the validator to confirm links and structure pass. ## Quick Start Ask the AI to create a README and quickstart for this project using the developer-documentation skill, verifying every documented command against the current code.

Frequently Asked Questions about developer-documentation

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

FAQPage Schema
How do I generate developer documentation from my codebase?▼

Invoke the skill with the document type you need, such as a README, quickstart, or CLI reference. It inspects your current code, tests, schemas, and command help first, then writes documentation that reflects implemented behavior rather than proposals.

What documentation types does this skill support?▼

It supports overviews, READMEs, quickstarts, tutorials, how-to guides, concept pages, API, SDK, and CLI references, installation and migration guides, operations runbooks, architecture decision records, release notes, and troubleshooting pages, each with a defined content contract.

How do I validate Markdown documentation structure?▼

Run scripts/validate_docs.py with one or more Markdown files or directories. It checks UTF-8 decoding, single level-one headings, heading level skips, closed code fences, local links, and image alt text, exiting 0 on pass and 1 on failure.

Does the Markdown validator check technical accuracy?▼

No. The validator only checks mechanical structure such as headings, links, and code fences. Technical claims and commands are verified separately by the skill against the current code, tests, interfaces, or runtime behavior.

Where do I install the skill for Codex or Claude Code?▼

Place the complete developer-documentation directory in .agents/skills/ for Codex or .claude/skills/ for Claude Code, at either project or user level. Keep all files together and restart the host if the skill does not appear.

Why does the validator report broken local links?▼

A broken local link means the target file does not exist relative to the source file. Update the link if the page moved or restore the missing page; use --check-fragments only when your publishing system uses GitHub-style heading anchors.