mcpField
G
gds-document-project

gds-document-project

github.com/bmad-code-orgDevelopment26244 installsUpdated 5w ago
Repository

About gds-document-project

gds-document-project is a BMad workflow for documenting existing projects to provide context for AI. It is intended for project documentation work and directs the workflow to follow its installed instructions.

Key features

  1. 01Documents existing projects for AI context
  2. 02Provides a project documentation workflow
  3. 03Uses configurable communication language
  4. 04Follows installed workflow instructions

Use cases

  1. 01Creating documentation for an existing project
  2. 02Preparing project context for AI use

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/bmad-code-org/bmad-module-game-dev-studio --skill gds-document-project

After installing, type/gds-document-projectin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

checklist.md
customize.toml
documentation-requirements.csv
instructions.md
templates/
deep-dive-template.md
index-template.md
project-overview-template.md
project-scan-report-schema.json
source-tree-template.md
workflows/
deep-dive-instructions.md
deep-dive-workflow.md
full-scan-instructions.md
full-scan-workflow.md

Details

From the project README

Document Project Workflow

Goal: Document brownfield projects for AI context.

Your Role: Project documentation specialist.

  • Communicate all responses in {communication_language}

Paths

  • installed_path = {skill-root}
  • instructions = {installed_path}/instructions.md
  • validation = {installed_path}/checklist.md
  • documentation_requirements_csv = {installed_path}/documentation-requirements.csv

Conventions

  • Bare paths (e.g. template.md) resolve from the skill root.
  • {skill-root} resolves to this skill's installed directory (where customize.toml lives).
  • {project-root} is the nearest folder containing _bmad/, starting at the project working directory and moving up through its parents.
  • {skill-name} resolves to the skill directory's basename.

On Activation

Step 1: Resolve the Workflow Block

Run: uv run {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --project-root {project-root} --key workflow

If the script fails, resolve the workflow block yourself by reading these three files in base → team → user order and applying the same structural merge rules as the resolver:

  1. {skill-root}/customize.toml — defaults
  2. {project-root}/_bmad/custom/{skill-name}.toml — team overrides
  3. {project-root}/_bmad/custom/{skill-name}.user.toml — personal overrides

Any missing file is skipped. Scalars override, tables deep-merge, arrays of tables keyed by code or id replace matching entries and append new entries, and all other arrays append.

Step 2: Execute Prepend Steps

Execute each entry in {workflow.activation_steps_prepend} in order before proceeding.

Step 3: Load Persistent Facts

Treat every entry in {workflow.persistent_facts} as foundational context you carry for the rest of the workflow run. Entries prefixed file: are paths or globs under {project-root} — load the referenced contents as facts. All other entries are facts verbatim.

Step 4: Load Config

Load config from {project-root}/_bmad/gds/config.yaml and resolve:

  • user_name
  • communication_language
Step 5: Greet the User

Greet {user_name}, speaking in {communication_language}.

Step 6: Execute Append Steps

Execute each entry in {workflow.activation_steps_append} in order.

Activation is complete. If activation_steps_prepend or activation_steps_append were non-empty, confirm every entry was executed in order before proceeding. Do not begin the main workflow until all activation steps have been completed.

EXECUTION

Read fully and follow: {installed_path}/instructions.md

Comments

Markdown supported