Skip to content

docs(zh-cn-reference): refresh workflow and skills references#2100

Merged
alexeyv merged 2 commits intobmad-code-org:mainfrom
lrliang:docs/e4s1-s4s2-cn-reference
Mar 24, 2026
Merged

docs(zh-cn-reference): refresh workflow and skills references#2100
alexeyv merged 2 commits intobmad-code-org:mainfrom
lrliang:docs/e4s1-s4s2-cn-reference

Conversation

@lrliang
Copy link
Copy Markdown
Contributor

@lrliang lrliang commented Mar 22, 2026

What

This PR updates four Chinese reference pages under docs/zh-cn/reference/:

  • workflow-map.md
  • commands.md
  • agents.md
  • core-tools.md

It aligns workflow/skill naming with the current BMad conventions, removes outdated bmad-bmm-* usage, improves cross-page Chinese navigation links, and keeps the reference tone concise and lookup-oriented.

本次 PR 修订了 docs/zh-cn/reference/ 下 4 篇中文参考页:workflow-map.mdcommands.mdagents.mdcore-tools.md。重点是对齐当前 BMad 的 workflow/skill 命名,移除过时 bmad-bmm-* 调用,补强中文页面之间的跳转,并保持参考文档应有的速查语气。

Why

The previous Chinese reference pages mixed legacy naming and older invocation semantics, which could mislead users when choosing workflows or calling skills. This change restores semantic parity with the current product behavior and reduces lookup friction for Chinese readers.

旧版中文参考页混用了历史命名与旧调用语义,用户在查阅阶段容易被误导(尤其是 workflow 选择和 skill 调用)。本次改动用于恢复与当前产品行为的一致性,并降低中文读者的检索成本。

How

  • Rewrote workflow-map.md to reflect current phase workflows and outputs (including bmad-sprint-status and bmad-quick-dev track).
  • Reframed commands.md as skills reference (generation model, storage paths, categories, troubleshooting) and aligned all examples to current skill IDs.
  • Expanded agents.md with Skill ID mapping and trigger-type guidance, including conversational trigger examples.
  • Refined core-tools.md into a cleaner query-style reference across 11 built-in tools.
  • Standardized admonition fences to ::: form in this batch to avoid rendering/config drift risks.
  • 重写 workflow-map.md,按当前阶段模型更新 workflow 与产出(含 bmad-sprint-statusbmad-quick-dev 快线)。
  • commands.md 重构为 skills 参考页(生成机制、目录路径、分类、排障),并统一示例为当前 skill 命名。
  • 扩展 agents.md,补齐 Skill ID 映射与触发器类型说明,并加入会话触发示例。
  • 收敛 core-tools.md 为更易检索的 11 项内置工具速查结构。
  • 本批次统一使用 ::: admonition 语法,规避渲染配置差异导致的静默展示回归。

Testing

Ran npm ci && npm run quality successfully.
This includes format checks, linting, markdown lint, docs build, installation component tests, file-reference validation, and skill validation.

已执行 npm ci && npm run quality 并通过。该流程覆盖格式检查、lint、Markdown lint、文档构建、安装组件测试、文件引用校验与技能校验。

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 22, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 4e189501-41dc-451e-b2ca-07fc650bddd0

📥 Commits

Reviewing files that changed from the base of the PR and between e3f935f and 8d525a1.

📒 Files selected for processing (4)
  • docs/zh-cn/reference/agents.md
  • docs/zh-cn/reference/commands.md
  • docs/zh-cn/reference/core-tools.md
  • docs/zh-cn/reference/workflow-map.md

📝 Walkthrough

Walkthrough

Chinese reference documentation updated to transition from slash-command terminology to skill-based naming. Content restructured across four files: agents.md adds Skill ID column and trigger-type distinctions; commands.md shifts focus from pre-built prompts to direct skill invocation and directory structure; core-tools.md condenses tool descriptions with streamlined inputs/outputs; workflow-map.md realigns workflow references and simplifies stage organization.

Changes

Cohort / File(s) Summary
Agent and Command Reference Updates
docs/zh-cn/reference/agents.md, docs/zh-cn/reference/commands.md
Restructured default agents documentation with new Skill ID column and trigger-type guidance; reframed commands reference from slash-prefixed invocation to direct skill names, updated generation mechanism from flat Markdown files to skill directories with SKILL.md entry points, rewrote troubleshooting and discovery sections to reference skills instead of commands.
Tool and Workflow References
docs/zh-cn/reference/core-tools.md, docs/zh-cn/reference/workflow-map.md
Condensed tool descriptions with streamlined input/output schemas and removed verbose constraints; updated workflow-map from diagram overview to quick-reference format with renamed phases, refreshed workflow names (e.g., bmad-create-architecture, bmad-sprint-status), and added "相关参考" section linking related documentation.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~22 minutes

Possibly related PRs

Suggested reviewers

  • bmadcode
  • alexeyv
🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title 'docs(zh-cn-reference): refresh workflow and skills references' directly and clearly describes the main change: updating Chinese reference documentation for workflows and skills.
Description check ✅ Passed The description is comprehensively related to the changeset, explaining what was updated (four specific files), why (aligning naming and removing legacy conventions), and how (specific rewrites and improvements).
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Tip

CodeRabbit can use your project's `biome` configuration to improve the quality of JS/TS/CSS/JSON code reviews.

Add a configuration file to your project to customize how CodeRabbit runs biome.

@augmentcode
Copy link
Copy Markdown

augmentcode bot commented Mar 22, 2026

🤖 Augment PR Summary

Summary: This PR refreshes the Chinese (zh-cn) reference docs to better match the current BMad Method “skills + workflows” model and improve cross-page navigation.

Changes:

  • Rewrites workflow-map.md to present phase-based workflows and outputs, including Quick Flow and sprint tracking entries.
  • Reframes commands.md as a Skills reference (generation, directory layout, discovery, troubleshooting) with updated examples.
  • Expands agents.md to include a quick lookup table for agents, triggers, and a trigger-type explanation section.
  • Streamlines core-tools.md into a query-style reference of built-in tools with clearer “定位/适用场景/机制” structure.
  • Standardizes admonition fences to ::: for more consistent rendering.

Technical Notes: The docs emphasize regenerated skills via npx bmad-method install, IDE-specific skills directories (e.g. .claude/skills/), and improved intra-zh-cn linking for faster lookup.

🤖 Was this summary useful? React with 👍 or 👎

Copy link
Copy Markdown

@augmentcode augmentcode bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review completed. 9 suggestions posted.

Fix All in Augment

Comment augment review to trigger a new review at any time.

## 注意事项
| 智能体 | Skill ID | 触发器 | 主要 workflow |
| --- | --- | --- | --- |
| Analyst (Mary) | `bmad-analyst` | `BP`、`RS`、`CB`、`DP` | Brainstorm、Research、Create Brief、Document Project |
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Analyst (Mary) 的触发器这里写了 RS,但当前 Mary 的 capabilities 里研究类触发器是 MR/DR/TR(market/domain/technical research)。如果 RS 已移除,这里可能会误导用户在会话内触发 research。

Severity: medium

Fix This in Augment

🤖 Was this useful? React with 👍 or 👎, or 🚀 if it prevented an incident/outage.

| 智能体 | 触发器 | 你需要提供的内容 |
| --- | --- | --- |
| Technical Writer (Paige) | `WD` | 要撰写的文档主题与目标 |
| Technical Writer (Paige) | `US` | 要补充到标准中的偏好/规范 |
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

这里把 Technical Writer 的会话触发器列为 US(Update Standards),但当前 bmad-agent-tech-writer 的 capabilities 表里没有 US(只有 DP/WD/MG/VD/EC)。如果 US 已下线或改名,这里需要对齐以免触发失败。

Severity: medium

Fix This in Augment

🤖 Was this useful? React with 👍 or 👎, or 🚀 if it prevented an incident/outage.

| --- | --- | --- |
| `bmad-brainstorming` | 通过引导式创意方法扩展方案空间 | `brainstorming-report.md` |
| `bmad-domain-research`、`bmad-market-research`、`bmad-technical-research` | 验证领域、市场与技术假设 | 研究发现 |
| `bmad-create-product-brief` | 沉淀产品方向与战略愿景 | `product-brief.md` |
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

这里的 workflow 名称写为 bmad-create-product-brief 且产出为 product-brief.md,但当前实现里对应 skill 似乎是 bmad-product-brief,且输出文件名包含项目名(如 product-brief-{project_name}.md)。如果这条是为了兼容旧名,建议明确“旧名/新名”关系,否则用户可能无法直接调用或定位产物。

Severity: medium

Fix This in Augment

🤖 Was this useful? React with 👍 or 👎, or 🚀 if it prevented an incident/outage.

@cccczl
Copy link
Copy Markdown
Contributor

cccczl commented Mar 23, 2026

Already fully checked, please @alexeyv merge.

我统一修订中文 reference 中 workflow-map、commands、agents、core-tools 四页,改正过时命名与调用方式,并将术语切换到当前 skills 体系。此前这些页面混用了旧版前缀和命令语义,容易让用户在查阅阶段误用流程;现在页面结构与英文源和现行实现保持一致,同时优先串联中文路径以提升检索效率。

Feishu: https://feishu.cn/wiki/TODO
Made-with: Cursor
@alexeyv alexeyv force-pushed the docs/e4s1-s4s2-cn-reference branch from 8d525a1 to 6e57779 Compare March 24, 2026 05:27
@alexeyv alexeyv merged commit 0d7d7da into bmad-code-org:main Mar 24, 2026
5 checks passed
@lrliang lrliang deleted the docs/e4s1-s4s2-cn-reference branch March 24, 2026 07:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants