MCPInstall

gds-document-project

Analyze existing game projects to produce useful documentation. Use when the user says "document project" or "generate docs"

Installs
42
Last 24h
—
Trending rank
—
Security
Not audited

Install

Works with every agent the skills CLI supports.

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

    Install

    Run the command in your project. The CLI asks which agents to install for.

  2. 02

    Describe the task

    Ask your agent for something this skill covers. It loads gds-document-project automatically when relevant.

  3. 03

    Review the result

    The agent follows the SKILL.md steps, scripts and references bundled with the skill.

SKILL.md

The instructions your agent reads when the skill is triggered.

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

FAQ

What does the gds-document-project skill do?

Analyze existing game projects to produce useful documentation. Use when the user says "document project" or "generate docs"

How do I install gds-document-project?

Run npx skills add https://github.com/bmad-code-org/bmad-module-game-dev-studio --skill gds-document-project in your project. The skills CLI detects the agents you use and copies the skill into the right folder. For Claude Code you can also place the skill folder at ~/.claude/skills/gds-document-project/ (personal) or .claude/skills/gds-document-project/ (project).

Which AI agents can use gds-document-project?

Any agent that supports the open Agent Skills format (a folder with a SKILL.md file), including Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, Windsurf, Cline, OpenCode and more.

Is gds-document-project safe to install?

No partner security audit is available yet. Skills can run commands and scripts, so read the SKILL.md and any bundled files before installing.

Who maintains gds-document-project?

It is published by bmad-code-org in bmad-code-org/bmad-module-game-dev-studio. It has 42 recorded installs.

More from bmad-code-org/bmad-module-game-dev-studio

View all →

gds-gdd

bmad-code-org/bmad-module-game-dev-studio

Open the skill to read its SKILL.md instructions.

Media & Creative54 installs

gds-brainstorm-game

bmad-code-org/bmad-module-game-dev-studio

Open the skill to read its SKILL.md instructions.

Media & Creative51 installs

gds-create-narrative

bmad-code-org/bmad-module-game-dev-studio

Open the skill to read its SKILL.md instructions.

Media & Creative50 installs

gds-agent-game-designer

bmad-code-org/bmad-module-game-dev-studio

Open the skill to read its SKILL.md instructions.

Media & Creative49 installs

gds-create-game-brief

bmad-code-org/bmad-module-game-dev-studio

Open the skill to read its SKILL.md instructions.

Media & Creative48 installs

gds-ux

bmad-code-org/bmad-module-game-dev-studio

Open the skill to read its SKILL.md instructions.

Popular docs & writing skills

View category →

grill-with-docs

mattpocock/skills

A relentless interview to sharpen a plan or design, which also creates docs (ADR's and glossary) as we go.

Docs & Writing1.2M installs

lark-markdown

open.feishu.cn

飞书 Markdown:查看、创建、上传、编辑和比较飞书中的原生 Markdown 文件。当用户要操作飞书 Markdown 文件,或比较其远端版本及本地草稿时使用。纯本地 Markdown 文件操作不触发本 skill。不负责将 Markdown 导入为飞书在线文档,也不负责文件搜索、权限、评论、移动、删除等云空间管理操作。

Docs & Writing778.7K installs

writing-beats

mattpocock/skills

Writing, exploit; assemble raw material into a journey of beats, grounding each term before a beat leans on it.

Docs & Writing490.7K installs

writing-shape

mattpocock/skills

Writing, exploit: shape raw material into an article, paragraph by paragraph.

Docs & Writing490.2K installs

writing-fragments

mattpocock/skills

Writing, explore: mine raw fragments, no structure yet.

Docs & Writing489.6K installs

writing-for-agents

mattpocock/skills

Writing documents for agents. Use when creating or editing skills, or modifying AGENTS.md or CLAUDE.md.

Docs & Writing479.3K installs