skills.rest
watchthelight
watchthelightCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

bmad-document-project

Forwards deprecated project documentation requests to the bmad-project-context skill.

Updated Sep 3, 2026
Search Tags:#documentation#codebase#project context#agents.md#deprecated#forwarding
One-click install
npx skills add https://github.com/watchthelight/shatterfish --skill bmad-document-project-watchthelight
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: bmad-document-project
Source: https://github.com/watchthelight/shatterfish/tree/main/.claude/skills/bmad-document-project
Command: npx skills add https://github.com/watchthelight/shatterfish --skill bmad-document-project-watchthelight

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? This Skill handles requests to "document this project" or "generate project docs" by redirecting them to the maintained bmad-project-context skill, since bulk generated documentation about codebases became stale and made agents less accurate. ## Core Features & Use Cases - Deprecation Notice: Informs the user that generating documentation volumes about a codebase is deprecated and explains why. - Request Forwarding: Invokes bmad-project-context with setup intent, passing the user's original request and any supplied paths or documents verbatim. - Expectation Setting: Clarifies that deeper system rationale and history material is a separate upcoming capability, not part of the AGENTS.md context block. - Use Case: A user asks to "document this project"; the Skill explains the deprecation and routes the request so the repo's AGENTS.md receives a small verified context block instead of stale prose. ## Quick Start Ask the assistant to document this project or generate project docs, and it will explain the deprecation and forward your request to bmad-project-context.

Frequently Asked Questions about bmad-document-project

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

FAQPage Schema
How do I generate documentation for my project?▼

Requesting project documentation triggers a forwarding flow: the request is passed verbatim to bmad-project-context with setup intent, which writes a small verified context block into the repo's AGENTS.md instead of generating prose documentation volumes.

Why was the document-project skill deprecated?▼

Generated documentation about codebases made agents worse, not better, because agents read code more accurately than prose describing it, and the generated docs were stale on arrival. Only a small verified AGENTS.md context block remains useful.

What does bmad-project-context write into AGENTS.md?▼

It records what the code cannot say: required policy, conventions that differ from defaults, what running the project takes that no config file states, and known pitfalls.

Can I still get deep explanations of a system's design and history?▼

Not through this skill. Deeper material covering system rationale and history is planned as its own separate capability and is not part of the AGENTS.md context block.

What happens to file paths I supply when requesting project docs?▼

Any paths or documents you supply are forwarded verbatim to bmad-project-context along with your original request, which then takes over the workflow.

Related Skills

Explore More Software Engineering Skills→
sparkfabriksparkfabrik
3

sf-create-agentsmd

Generate or review AGENTS.md files with scaffolded sections and CI integration notes.

Official
Advanced
generic-automation-and-itgeneric-automation-and-it

context-load-context

Discovers and loads domain AGENTS.md context files before code changes.

Official
Intermediate
statsclawstatsclaw
89

brain-sync

Coordinate consent-gated knowledge sharing and automated PR creation for StatsClaw workflows.

Official
Advanced
codjeremias-cellcodjeremias-cell
1

docs-projeto

Generates READMEs, user manuals, technical docs, changelogs, and wikis from verified project code.

Community
Advanced