dev-docs

Generate structured developer documentation with source verification against codebases.

2|Updated Nov 16, 2024
One-click install
npx skills add https://github.com/onairmarc/dotfiles --skill dev-docs-onairmarc
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: dev-docs
Source: https://github.com/onairmarc/dotfiles/tree/main/.agents/skills/dev-docs
Command: npx skills add https://github.com/onairmarc/dotfiles --skill dev-docs-onairmarc

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Developers and teams often struggle to produce accurate, up-to-date documentation that perfectly reflects the codebase, API surfaces, and integration patterns.

Core Features & Use Cases

  • Structured documentation templates aligned to code terminology and project conventions
  • API / architecture references with placeholders for code examples and diagrams
  • Verification guidance comparing docs to actual source code and config schemas
  • Adaptation guidance for new languages or stacks based on the codebase

Quick Start

Generate a complete developer documentation draft for the target feature, starting with an Overview and prerequisites.

Frequently Asked Questions about dev-docs

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

FAQPage Schema
How do I generate developer documentation that matches my codebase?

Generate developer documentation by applying a structured framework with sections like Overview, Prerequisites, Architecture, and API Reference. The process includes source verification to ensure the documentation aligns perfectly with your actual codebase and configuration schemas.

What is the best way to structure API reference documentation for software projects?

The best way to structure API reference documentation is using a standardized template covering Overview, Prerequisites, API Reference, Configuration, Code Examples, and Integration Guide. This framework ensures all integration patterns and architecture decisions are accurately documented.

Can I create architecture and integration guides for modern codebases?

Yes, you can create architecture and integration guides for modern codebases. The documentation framework applies to architecture decisions, configuration details, and integration patterns, adapting to new languages or stacks based on your project conventions.

How do you verify developer docs against the actual source code?

Verify developer docs against source code by applying built-in verification guidance that compares the documentation content directly to the actual source code and configuration schemas. This ensures the generated API references and architecture details remain perfectly aligned.

Does this developer documentation generator work for any programming language?

Yes, the developer documentation generator works across modern codebases by providing adaptation guidance for new languages or stacks. It aligns the structured documentation templates directly to your code terminology and specific project conventions.

What should be included in developer documentation for complex APIs?

Developer documentation for complex APIs should include an Overview, Prerequisites, Architecture, API Reference, Configuration, Code Examples, Integration Guide, and Troubleshooting. Placeholders for code examples and diagrams are also supported within the structured template.