DOCUMENT_PROJECT_STATE

Document codebase architecture and tech debt in a structured markdown file.

22|4|Updated Oct 28, 2025
One-click install
npx skills add https://github.com/ivfarias/ceo --skill document-project-state
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: DOCUMENT_PROJECT_STATE
Source: https://github.com/ivfarias/ceo/tree/main/.gemini/skills/document-project-state
Command: npx skills add https://github.com/ivfarias/ceo --skill document-project-state

SYSTEM DOCUMENTATION & REQUIREMENTS

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.

Frequently Asked Questions about DOCUMENT_PROJECT_STATE

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

FAQPage Schema
How do I document a legacy codebase architecture for onboarding?

Document a legacy codebase architecture for onboarding by analyzing real repository files to map project structure, tech stack, and technical debt. This process generates a comprehensive architecture document with versioned dependencies and debt warnings to accelerate team onboarding.

What is the best way to capture technical debt in an existing project?

The best way to capture technical debt in an existing project is through deep analysis of key files like configuration, data models, and APIs. This yields a structured architecture document that highlights debt warnings and critical codebase patterns for long-term maintenance.

How do I generate an architecture document with exact tech stack versions?

Generate an architecture document with exact tech stack versions by running automated discovery on project files like package.json and README.md. This maps the system and produces a validated markdown file detailing your tech stack, key patterns, and critical files.

Can I automatically map a project structure from real repository files?

Yes, you can automatically map a project structure from real repository files. The system performs automated discovery on files like package.json and the src/ layout to map the system, validates against the real repository, and generates a structured architecture doc.

What should be included in a codebase architecture document?

A codebase architecture document should include a project overview, exact tech stack versions, key patterns, critical files, and technical debt warnings. Drafting this comprehensive document relies on deep analysis of entry points, configuration, data models, and APIs.

Does this approach work for documenting legacy code without existing documentation?

Yes, this approach works for documenting legacy code without existing documentation by guiding engineers through discovery, analysis, and drafting. It applies reality-based analysis to surface critical details and generate a lean architecture document.