DOCUMENT_PROJECT_STATE

Community

Capture a codebase's architecture and debt.

Authorivfarias
Version1.0.0
Installs0

System Documentation

What problem does it solve?

Documenting a codebase's current state is time-consuming and error-prone. This Skill provides reality-based, lean documentation of architecture, tech stack, and technical debt to accelerate onboarding and long-term maintenance.

Core Features & Use Cases

  • Automated discovery of project structure (e.g., package.json, README.md, src/ layout) to map the system.
  • Deep analysis of key files (entry points, configuration, data models, APIs) to surface critical details.
  • Drafting a comprehensive architecture document with sections for overview, tech stack with exact versions, key patterns, critical files, and debt warnings.
  • Validation against the real repository and generation of the output at docs/architecture/{{project_name}}-architecture.md.

Quick Start

Generate a complete architecture document for the target codebase using real files in the repository.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: DOCUMENT_PROJECT_STATE
Download link: https://github.com/ivfarias/ceo/archive/main.zip#document-project-state

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 510,000+ vetted skills library on demand.