gds-document-project

Generates structured documentation for existing brownfield codebases through guided project scans.

Updated Sep 3, 2026
One-click install
npx skills add https://github.com/watchthelight/shatterfish --skill gds-document-project-watchthelight
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: gds-document-project
Source: https://github.com/watchthelight/shatterfish/tree/main/.claude/skills/gds-document-project
Command: npx skills add https://github.com/watchthelight/shatterfish --skill gds-document-project-watchthelight

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Brownfield projects often lack documentation that AI agents and new developers can use to understand the codebase. This Skill scans an existing project and produces a complete documentation set (index, architecture, source tree, API contracts, data models, development guides) ready for brownfield PRD planning. ## Core Features & Use Cases - Three Scan Levels: Quick (pattern-based, no source reading), Deep (reads critical directories), and Exhaustive (reads every source file), with batching and write-as-you-go output to keep context lean. - Project Type Detection: Classifies projects against 12 types (web, mobile, backend, CLI, library, desktop, game, data, extension, infra, embedded) using a documentation-requirements CSV, and handles monolith, monorepo, and multi-part structures. - Resumable State Tracking: Maintains a project-scan-report.json state file so interrupted runs can resume from the exact step, archiving state files older than 24 hours. - Deep-Dive Mode: Performs exhaustive full-file analysis of a chosen folder, feature, or API group, producing dependency graphs, data flow traces, and contributor guidance. - Use Case: Point it at a legacy repository, choose a deep scan, and receive an index.md plus architecture, source-tree, and development-guide documents that an AI agent can immediately use for feature planning. ## Quick Start Ask the assistant to document this project and choose a scan level when prompted.

Frequently Asked Questions about gds-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?

Run the document-project workflow and choose a scan level: quick for pattern-based analysis, deep for reading critical directories, or exhaustive for reading every source file. The workflow writes an index.md plus architecture, source-tree, and development-guide documents to your output folder.

What scan level should I choose for project documentation?

Quick scan takes 2-5 minutes and only reads configs and manifests, deep scan takes 10-30 minutes reading critical directories, and exhaustive scan takes 30-120 minutes reading all source files. Deep scan is recommended for brownfield PRD preparation.

Can I resume an interrupted documentation scan?

Yes. The workflow maintains a project-scan-report.json state file tracking completed steps, cached project types, and outputs. If the state file is under 24 hours old, you are prompted to resume from the exact step where the run stopped.

Does it support monorepos and multi-part projects?

Yes. The workflow detects client/server and similar multi-part structures, classifies each part separately, and generates per-part architecture, component, and development documents plus an integration-architecture.md and project-parts.json metadata file.

What is deep-dive mode in project documentation?

Deep-dive mode exhaustively reads every file in a chosen folder, feature, or API group and produces a document with complete file inventories, dependency graphs, data flow traces, testing analysis, and modification guidance. Sampling or skipping files is not allowed in this mode.