generate-project-docs

Generate onboarding guides, data flow analysis, and API endpoint specifications from source code.

1|Updated Dec 1, 2016
One-click install
npx skills add https://github.com/aaron-vaz/dotfiles --skill generate-project-docs-aaron-vaz
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: generate-project-docs
Source: https://github.com/aaron-vaz/dotfiles/tree/main/opencode/.opencode/skills/generate-project-docs
Command: npx skills add https://github.com/aaron-vaz/dotfiles --skill generate-project-docs-aaron-vaz

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill automates the creation of detailed project documentation, streamlining engineer onboarding, knowledge transfer, and system understanding.

Core Features & Use Cases

  • Code-First Analysis: Ensures all documentation is based on actual source code, not assumptions.
  • Multiple Documentation Types: Generates onboarding guides, flow documentation, component analysis, and API endpoint documentation.
  • Use Case: When a new engineer joins a project, use this Skill to generate an onboarding guide that covers the tech stack, project structure, and key components, significantly reducing ramp-up time.

Quick Start

Use the generate-project-docs skill to create an onboarding guide for the current project.

Frequently Asked Questions about generate-project-docs

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

FAQPage Schema
How do I generate project documentation from source code?

Generate project documentation by analyzing actual source code to produce onboarding guides, data flow analysis, component deep dives, and API endpoint specifications. This code-first approach ensures all documentation reflects the real project structure and implementation logic.

Can I create onboarding guides for any programming language or framework?

Yes, you can create onboarding guides for projects across any programming language or framework. The documentation generation works by analyzing actual source code directly, ensuring language-agnostic coverage of the tech stack, project structure, and key components.

What is code-first documentation and how does it work?

Code-first documentation ensures all generated onboarding guides, flow documentation, and API endpoint specifications are based strictly on actual source code analysis rather than assumptions. This approach guarantees technical accuracy and alignment with the real project structure and component interactions.

How do I document API endpoints and data flow for an existing project?

Document API endpoints and data flow by analyzing the project's actual source code. This generates comprehensive API endpoint specifications and flow documentation that accurately reflect the current implementation, streamlining knowledge transfer and system understanding.

Does this documentation generation require access to the full source code?

Yes, generating accurate project documentation requires direct access to the source code. This code-first analysis principle ensures the resulting onboarding guides, component deep dives, and API specifications precisely match the actual implementation logic and project structure.