How do I install the DOCUMENT_PROJECT_STATE skill?

Run npx skillmds add majiayu000/document-project-state in your terminal (requires Node.js), paste this page's agent-chat prompt into Claude, Cursor, or any MCP-connected agent, or download the SKILL.md file and copy it into your agent's skills directory.

Is DOCUMENT_PROJECT_STATE safe to use?

This skill has not completed SkillMD's automated safety review yet. Capability flags: docs only. SkillMD never runs a skill's scripts for you; review the SKILL.md before installing.

Which AI agents work with DOCUMENT_PROJECT_STATE?

This skill is tagged as working with Claude Code, Claude.ai, OpenAI Codex. SKILL.md is an open format, so most agents that read a skills directory can load it too.

Is DOCUMENT_PROJECT_STATE free to use?

Yes. Installing skills from SkillMD is free, and the skill stays under its author's original license.

Who published DOCUMENT_PROJECT_STATE?

majiayu000 (@majiayu000) published this skill. Their other Agent Skills are listed on their SkillMD profile.

DOCUMENT_PROJECT_STATE by majiayu000

Name: DOCUMENT_PROJECT_STATE
Rating: 4.5 (4 reviews)
Author: majiayu000

DOCUMENT_PROJECT_STATE

Generate documentation for an existing project. USE WHEN onboarded to a new codebase OR documenting legacy code. Capabilities include architectural mapping, tech stack inventory, and technical debt documentation.

majiayu000 b0f2d67 2 files · 2.6 KB Updated Sep 9, 2026 567 repo stars

File contents

DOCUMENT PROJECT

Owner: Devon (Developer)

Goal

To produce accurate, reality-based documentation for an existing codebase. This is about documenting what is, not what should be.

Core Principles

Reality Over Theory: Document the actual patterns, even the ugly ones.
Lean: Focus on what an AI agent or new developer needs to know to work.
Automated Discovery: Use tools to read the code, don't just ask the user.

Workflow Instructions

1. Scope & Elicitation

Action: Determine what to document.
Prompt: "Are we documenting the whole system or just a specific module?"
Check: Is there a PRD? If so, focus on relevant areas.

2. Discovery

Action: Map the codebase.
Targets: package.json, README.md, src/ structure, build scripts.
Tool: Use context7 to identify frameworks and versions.

3. Deep Analysis

Action: Read key files.
Focus: Entry points, config, auth, data models, API routes.
Identify:
- Patterns: How is code organized?
- Debt: What looks hacky or legacy?
- Integration: External APIs?

4. Drafting the Architecture Doc

Action: Assemble the insights.
Template: .claude/templates/architecture-tmpl.yaml (conceptual reference).
Sections:
- Overview: System purpose.
- Tech Stack: Exact versions (verified).
- Key Patterns: How to write code here.
- Critical Files: The map.
- Technical Debt: Warnings for the agent.

5. Review & Save

Action: Validate against reality.
Check: Do the file paths exist? Are the versions correct?
Write: docs/architecture/{{project_name}}-architecture.md.

Anti-Patterns

NEVER document theoretical best practices that aren't followed in the code.
NEVER omit version numbers for core dependencies.
NEVER generate generic "boilerplate" documentation.

Output Format

A comprehensive Markdown architecture document.

---name: document-project-statedescription: Generate documentation for an existing project. USE WHEN onboarded to a new codebase OR documenting legacy code. Capabilities include architectural mapping, tech stack inventory, and technical debt documentation.--- # DOCUMENT PROJECT **Owner:** Devon (Developer) ## Goal To produce accurate, reality-based documentation for an existing codebase. This is about documenting *what is*, not *what should be*. ## Core Principles - **Reality Over Theory:** Document the actual patterns, even the ugly ones. - **Lean:** Focus on what an AI agent or new developer needs to know to work. - **Automated Discovery:** Use tools to read the code, don't just ask the user. ## Workflow Instructions ### 1. Scope & Elicitation - **Action:** Determine what to document. - **Prompt:** "Are we documenting the whole system or just a specific module?" - **Check:** Is there a PRD? If so, focus on relevant areas. ### 2. Discovery - **Action:** Map the codebase. - **Targets:** `package.json`, `README.md`, `src/` structure, build scripts. - **Tool:** Use `context7` to identify frameworks and versions. ### 3. Deep Analysis - **Action:** Read key files. - **Focus:** Entry points, config, auth, data models, API routes. - **Identify:** - **Patterns:** How is code organized? - **Debt:** What looks hacky or legacy? - **Integration:** External APIs? ### 4. Drafting the Architecture Doc - **Action:** Assemble the insights. - **Template:** `.claude/templates/architecture-tmpl.yaml` (conceptual reference). - **Sections:** - **Overview:** System purpose. - **Tech Stack:** Exact versions (verified). - **Key Patterns:** How to write code here. - **Critical Files:** The map. - **Technical Debt:** Warnings for the agent. ### 5. Review & Save - **Action:** Validate against reality. - **Check:** Do the file paths exist? Are the versions correct? - **Write:** `docs/architecture/{{project_name}}-architecture.md`. ## Anti-Patterns - **NEVER** document theoretical best practices that aren't followed in the code. - **NEVER** omit version numbers for core dependencies. - **NEVER** generate generic "boilerplate" documentation. ## Output Format A comprehensive Markdown architecture document.

Frequently asked questions