本文へ移動
cccskills
無料GitHub で公開

bmad-document-project

Document brownfield projects for AI context. Use when the user says "document this project" or "generate project docs"

インストール方法を見る

含まれるファイル(14)

  • SKILL.md2.6 KB
  • checklist.md9.9 KB
  • customize.toml1.6 KB
  • documentation-requirements.csv7.9 KB
  • instructions.md5.0 KB
  • templates/deep-dive-template.md5.7 KB
  • templates/index-template.md4.4 KB
  • templates/project-overview-template.md1.9 KB
  • templates/project-scan-report-schema.json4.7 KB
  • templates/source-tree-template.md2.1 KB
  • workflows/deep-dive-instructions.md11.9 KB
  • workflows/deep-dive-workflow.md979 B
  • workflows/full-scan-instructions.md42.4 KB
  • workflows/full-scan-workflow.md970 B

SKILL.md(原文)

インストールする前に、エージェントに与えられる指示の中身を確認できます。

Document Project Workflow

Goal: Document brownfield projects for AI context.

Your Role: Project documentation specialist.

Conventions

  • Bare paths (e.g. instructions.md) resolve from the skill root.
  • {skill-root} resolves to this skill's installed directory (where customize.toml lives).
  • {project-root}-prefixed paths resolve from the project working directory.
  • {skill-name} resolves to the skill directory's basename.

On Activation

Step 1: Resolve the Workflow Block

Run: python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-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/bmm/config.yaml and resolve:

  • Use {user_name} for greeting
  • Use {communication_language} for all communications
  • Use {document_output_language} for output documents
  • Use {planning_artifacts} for output location and artifact scanning
  • Use {project_knowledge} for additional context scanning

Step 5: Greet the User

Greet {user_name} (if you have not already), 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: ./instructions.md

レビュー

まだレビューはありません。使ってみた感想をお寄せください。

同じリポジトリのスキル

概要と使いどころ

代码仓库 AI 亲和度审计工具,支持前端、后端、全栈等各类项目。此技能用于检查给定的代码仓库对 AI Coding 工具的友好程度,生成详细的分析报告和改进建议。当用户需要评估代码仓库是否适合 AI 辅助开发、希望提升仓库的 AI 可操作性、或准备引入 AI Coding 工具前进行仓库评估时,应使用此技能。支持 TypeScript/JavaScript、Go、Java/Kotlin、Python、Rust 等主流技术栈。融合 OpenAI Harness Engineering 方法论,评估 Outer Loop(反馈闭环、评估门禁、机械化不变量)建设。

日本語の概要は準備中です。原文の説明を表示しています。

alibaba/opc-starter882026年7月22日 更新

OPC-Starter 智能开发技能。AI 亲和的 React Boilerplate 项目开发规范,支持动态上下文感知、TDD 驱动开发、Agent Studio 扩展。适用于认证系统、组织架构、Agent 工具、数据同步等模块的迭代开发。

日本語の概要は準備中です。原文の説明を表示しています。

alibaba/opc-starter882026年7月22日 更新

Push the LLM to reconsider, refine, and improve its recent output. Use when user asks for deeper critique or mentions a known deeper critique method, e.g. socratic, first principles, pre-mortem, red team.

日本語の概要は準備中です。原文の説明を表示しています。

alibaba/opc-starter882026年7月22日 更新

Strategic business analyst and requirements expert. Use when the user asks to talk to Mary or requests the business analyst.

日本語の概要は準備中です。原文の説明を表示しています。

alibaba/opc-starter882026年7月22日 更新

System architect and technical design leader. Use when the user asks to talk to Winston or requests the architect.

日本語の概要は準備中です。原文の説明を表示しています。

alibaba/opc-starter882026年7月22日 更新

Builds, edits or analyzes Agent Skills through conversational discovery. Use when the user requests to "Create an Agent", "Analyze an Agent" or "Edit an Agent".

日本語の概要は準備中です。原文の説明を表示しています。

alibaba/opc-starter882026年7月22日 更新

alibaba のスキルをすべて見る

このスキルの問題を報告する