skills.rest
GuidoBergman
GuidoBergmanCOMMUNITY
Explore all skills by this author →
GitHub

document-project

Scan codebases to generate reference documentation for brownfield projects.

Updated Jan 29, 2026
Search Tags:#code analysis#documentation#workflow automation#AI development#brownfield#project understanding
One-click install
npx skills add https://github.com/GuidoBergman/aegish --skill document-project-guidobergman
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-project
Source: https://github.com/GuidoBergman/aegish/tree/main/.claude/skills/document-project
Command: npx skills add https://github.com/GuidoBergman/aegish --skill document-project-guidobergman

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill addresses the challenge of understanding and documenting complex, existing "brownfield" software projects, making them more accessible for new developers and AI-assisted development.

Core Features & Use Cases

  • Codebase Scanning: Analyzes existing code to identify architecture, patterns, and dependencies.
  • Documentation Generation: Creates comprehensive reference documentation based on the analysis.
  • AI-Assisted Development: Provides a solid foundation for AI tools to understand and contribute to the project.
  • Use Case: Onboarding a new developer to a legacy system by providing them with a clear, AI-generated overview of its structure and key components.

Quick Start

Load the workflow configuration at .bmad/bmm/workflows/document-project/workflow.yaml and execute it.

Frequently Asked Questions about document-project

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

FAQPage Schema
How do I generate documentation for a legacy brownfield project?▼

Documenting an existing codebase involves scanning code to identify architecture, patterns, and dependencies, producing structured reference documentation that gives AI tools and new developers a clear overview of project structure and key components.

What is the best way to prepare a codebase for AI-assisted development?▼

Preparing a codebase for AI-assisted development involves analyzing existing project architecture and patterns to generate structured documentation, providing AI tools the foundational understanding needed to contribute to the codebase effectively.

Can I analyze existing code architecture without setting up dependencies?▼

Yes, you can analyze existing code architecture without external dependencies. This Skill operates independently with no required dependencies to scan the codebase and identify structural patterns directly from the project files.

How do I execute the document-project workflow configuration?▼

To execute the workflow, load the specified configuration file located at .bmad/bmm/workflows/document-project/workflow.yaml and run it to initiate the detailed codebase scanning and documentation processing logic.

Does AI-generated code understanding work for onboarding new developers to complex legacy systems?▼

Yes, AI-generated code understanding works for onboarding by providing a clear, generated overview of legacy system structure and key components, making complex existing software projects accessible to new developers.

Related Skills

Explore More Software Engineering Skills→
GeargrindadminGeargrindadmin

bmad-os-audit-file-refs

Audit BMAD source files for file-reference convention violations using parallel Haiku subagents.

Community
Intermediate
BoltDoggyBoltDoggy

doc-first

Enforce documentation alongside all code changes in development workflows.

Community
Advanced
brittbritt
1

project-analysis

Analyzes project codebase structure, architecture, key files, and dependencies via filesystem scanning tools.

Community
Intermediate
temptemp3temptemp3
2

docs

Summarize arccjs architecture and conventions from the docs folder.

Community
Advanced