gds-document-project

Generate structured index, architecture, and data-model docs from existing game codebases.

212|23|Updated Jan 15, 2026
One-click install
npx skills add https://github.com/bmad-code-org/bmad-module-game-dev-studio --skill gds-document-project-bmad-code-org
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: gds-document-project
Source: https://github.com/bmad-code-org/bmad-module-game-dev-studio/tree/main/src/workflows/gds-document-project
Command: npx skills add https://github.com/bmad-code-org/bmad-module-game-dev-studio --skill gds-document-project-bmad-code-org

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Document brownfield game development projects by producing structured, browsable documentation from existing codebases.

Core Features & Use Cases

  • Automated project documentation: analyzes code, configs, and architecture signals to generate an indexed docs suite.
  • Multi-part support: handles monorepos or multi-part game stacks (Unity/Unreal/Godot ecosystems) by identifying parts and creating per-part artifacts.
  • Outputs and navigation: produces index.md, architecture, data models, and source-tree analyses, with optional deep-dives for focused areas.

Quick Start

Run the document-project workflow on your repository to generate initial indexing and documentation for brownfield projects.

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 game project codebase?

To generate documentation for an existing game project, you need a workflow that reads project roots, key files, and manifests to detect project type and outputs an index plus architecture and data-model docs. It produces structured, browsable documentation directly from brownfield codebases.

What is a brownfield project documentation generator and how does it work?

A brownfield project documentation generator analyzes existing code, configs, and architecture signals within a repository to automatically produce an indexed docs suite. It reads manifests and key files to detect project type and map the current architecture without manual writing.

Can I generate architecture and data model docs for a multi-part game repository?

Yes, you can generate architecture and data model docs for multi-part game repositories. The workflow handles monorepos or multi-part game stacks by identifying individual parts and creating per-part artifacts alongside the main index documentation.

How do I document source-tree structure and integration points in an existing codebase?

To document source-tree structure and integration points in an existing codebase, run an automated documentation workflow that analyzes your project root and configs. It produces source-tree analyses and architecture docs to map these integration points automatically.

Does automated project documentation work with Unity, Unreal, or Godot ecosystems?

Yes, automated project documentation works with Unity, Unreal, and Godot ecosystems. The workflow handles multi-part game stacks by identifying individual engine parts within the repository and creating per-part documentation artifacts.

What is the best way to create a browsable documentation index for a legacy codebase?

The best way to create a browsable documentation index for a legacy codebase is using an automated workflow that reads project roots and manifests to generate an index.md file. This serves as the entry point to architecture, data models, and source-tree analyses.