documentation

Generate API references, architecture diagrams, and README content from codebases.

Updated Aug 29, 2025
One-click install
npx skills add https://github.com/DDTully/dotfiles --skill documentation-ddtully
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: documentation
Source: https://github.com/DDTully/dotfiles/tree/main/skills/.agent_skills/documentation
Command: npx skills add https://github.com/DDTully/dotfiles --skill documentation-ddtully

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Streamlines the creation of API docs, architecture diagrams, READMEs, and inline code comments by providing a cohesive workflow bundle that stitches together multiple documentation outputs from a codebase.

Core Features & Use Cases

  • API documentation generation and OpenAPI spec creation
  • Architecture and data-flow documentation with diagram generation
  • README and getting-started guides, plus code-comment driven docs
  • Wiki, knowledge-base maintenance, and template-driven outputs
  • Phase-based workflow orchestration across planning, API, architecture, and README phases

Quick Start

Provide an end-to-end documentation plan for a new codebase using the workflow bundle

Frequently Asked Questions about documentation

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

FAQPage Schema
How do I generate API documentation and OpenAPI specs from an existing codebase?

API documentation generation extracts endpoints and schemas from your codebase to produce API references and OpenAPI specs. This Skill orchestrates that extraction as part of a phase-based workflow, outputting consistent API docs alongside architecture diagrams and README content.

What is the best way to automate architecture diagram and data-flow documentation for a software project?

Automating architecture diagram and data-flow documentation involves parsing codebase structure to generate visual templates. This Skill orchestrates generation of architecture diagrams and data-flow docs within a multi-phase workflow, ensuring visual documentation stays consistent with code.

Can I generate README files and inline code comments simultaneously across my project?

README files and inline code comments can be generated simultaneously through a unified documentation workflow. This Skill coordinates README and getting-started guide creation with code-comment driven docs, producing cohesive multi-format outputs from a single codebase analysis.

Does this documentation workflow support template-driven outputs for wiki and knowledge-base maintenance?

Template-driven outputs for wiki and knowledge-base maintenance are supported. The workflow bundle generates structured templates across documentation phases, enabling consistent wiki updates and knowledge-base population directly from your codebase and architecture data.

How do I plan an end-to-end documentation workflow for a new software project?

Planning end-to-end documentation requires a phase-based workflow covering planning, API, architecture, and README stages. This Skill provides a workflow bundle that orchestrates these phases, generating release notes, diagrams, and user guides from the codebase.