rcode-document-project

Scan repositories and generate structured AI-ready documentation for brownfield codebases.

2|1|Updated Apr 10, 2026
One-click install
npx skills add https://github.com/hanzlahabib/rcode --skill rcode-document-project
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: rcode-document-project
Source: https://github.com/hanzlahabib/rcode/tree/main/rcode/skills/actions/1-analysis/rcode-document-project
Command: npx skills add https://github.com/hanzlahabib/rcode --skill rcode-document-project

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill turns an existing codebase into accurate, AI-friendly documentation, helping teams understand brownfield systems without manually tracing every folder, file, and workflow.

Core Features & Use Cases

  • Scans a repository, classifies its structure, and captures the stack, architecture, and documentation gaps.
  • Produces a full documentation set for humans and LLMs, including project overview, source tree, architecture, development guidance, and optional API or data-model docs.
  • Handles resumable workflows, scan-depth selection, multi-part repositories, and deep-dive analysis for specific modules.
  • Use it when you need to onboard onto an unfamiliar repo, prepare brownfield PRD context, or refresh outdated docs after a codebase change.

Quick Start

Ask this Skill to document the repository so it can analyze the existing codebase and generate the appropriate project documentation.

Frequently Asked Questions about rcode-document-project

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

FAQPage Schema
How do I generate documentation for an existing codebase to provide LLM context?

To generate documentation for an existing codebase for LLM context, you scan the repository to classify its structure, capturing the stack and architecture to produce structured, AI-ready docs like project overviews and development guidance.

What is the best way to document a brownfield repository before onboarding?

The best way to document a brownfield repository is scanning it to capture source-tree mapping, architecture summaries, and documentation gaps, which creates a full documentation set for both human onboarding and LLM processing.

Can I control the scan depth when analyzing a large codebase?

Yes, you can control the scan depth when analyzing a large codebase. The process supports scan-depth selection and resumable state tracking, allowing you to manage multi-part repositories and perform deep-dive analysis for specific modules.

Does repository scanning work for generating API and data-model documentation?

Yes, repository scanning works for generating API and data-model documentation. Alongside architecture summaries and source-tree mapping, it produces optional API or data-model documentation artifacts as part of the overall documentation set.

How do I refresh outdated architecture documentation after a codebase change?

To refresh outdated architecture documentation after a codebase change, you rescan the repository to validate and regenerate the structured documentation artifacts, ensuring the project overview and development guidance accurately reflect the updated state.

Why does codebase analysis require resumable state tracking for multi-part repositories?

Codebase analysis requires resumable state tracking for multi-part repositories to handle large or complex structures without losing progress, allowing the scan to pause and resume while accurately aggregating architecture summaries and source-tree mappings.