harness-document-project
CommunityGenerate brownfield project docs for AI agents.
Software Engineering#architecture#ai context#brownfield#document#project scanning#resumable workflow#validation proofs
Authorbaobao0303
Version1.0.0
Installs0
System Documentation
What problem does it solve?
This Skill turns an existing (brownfield) codebase into structured, AI-friendly project documentation so agents can understand intent, architecture, and constraints before changing code.
Core Features & Use Cases
- Brownfield documentation workflow: Guides the user through a standardized process to produce a complete documentation set for an existing project.
- Scan-depth options with resumable state: Supports quick/deep/exhaustive modes and maintains an on-disk state report to resume interrupted runs.
- Architecture- and risk-aware outputs: Produces artifacts like a source tree analysis, architecture docs, and (when applicable) API contracts, data models, and development/deployment guidance.
Quick Start
Ask the AI to use this skill to document the current repository by running the document-project workflow.
Dependency Matrix
Required Modules
python3
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: harness-document-project Download link: https://github.com/baobao0303/harness/archive/main.zip#harness-document-project Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.