harness-document-project

Document brownfield repositories into structured artifacts for AI coding agents.

1|Updated May 23, 2026
One-click install
npx skills add https://github.com/baobao0303/harness --skill harness-document-project
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: harness-document-project
Source: https://github.com/baobao0303/harness/tree/main/.agents/skills/harness-document-project
Command: npx skills add https://github.com/baobao0303/harness --skill harness-document-project

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires python3.

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.

Frequently Asked Questions about harness-document-project

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

FAQPage Schema
How do I document an existing brownfield project for AI coding agents?

Documenting a brownfield project for AI coding agents involves scanning the existing codebase to generate structured artifacts like source tree analysis and architecture docs, ensuring agents understand constraints before modifying code.

What is the best way to provide AI context for an existing code repository?

Providing AI context for an existing repository requires converting missing project context into structured documentation artifacts, utilizing scan-depth options and resumable state tracking to capture architecture and risk-aware outputs.

Can I resume an interrupted project scanning workflow?

Yes, you can resume an interrupted project scanning workflow because the process maintains an on-disk state report within project_knowledge, allowing interrupted deep-dive analysis runs to safely resume.

Does the brownfield documentation workflow support YAML-defined customization?

Yes, the brownfield documentation workflow supports YAML-defined behavior, enabling customization resolution, config loading, and persistent-facts ingestion to structure the project scanning process.

What scan-depth options are available for generating project architecture docs?

Available scan-depth options for generating project architecture docs include quick, deep, and exhaustive modes, allowing you to control the scan level and produce exhaustive deep-dive analysis or rapid initial scans.

Do I need python3 to generate AI-friendly project documentation?

Yes, you need python3 installed as a dependency to run the document-project workflow, which processes the codebase and outputs structured documentation artifacts for AI agents.