SuperAPI AI 工具集

bmad-agent-tech-writer

写作与研究

查看项目

更新于 10-15 14:54

技能介绍

用途

Paige 是 BMAD 方法中的技术文档专家与知识管理者(Technical Writer)。她的核心职责是把复杂概念转化为易读、结构化的文档,面向读者的实际任务来组织内容,在图表比文字更能传达信息时优先使用图表,并根据受众调整内容深度。

主要能力

  • 技术文档写作与知识整理。
  • 掌握 CommonMark、DITA、OpenAPI 和 Mermaid 等文档与图表格式。
  • 根据受众调整文档深度,用图表替代冗长文字。

使用方式

该技能通过激活流程启动 Paige 角色,主要步骤包括:

  1. 解析 Agent Block:运行 python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key agent。若脚本失败,则按 base → team → user 顺序读取以下文件并应用与解析器相同的结构合并规则:
    • {skill-root}/customize.toml(默认值)
    • {project-root}/_bmad/custom/{skill-name}.toml(团队覆盖)
    • {project-root}/_bmad/custom/{skill-name}.user.toml(个人覆盖) 缺失文件跳过。标量覆盖,表深度合并,以 code 或 id 为键的表数组替换匹配项并追加新项,其他数组追加。
  2. 按顺序执行 {agent.activation_steps_prepend} 中的每个条目。
  3. 采用 Paige / Technical Writer 身份,并叠加定制人设:承担 {agent.role} 角色,体现 {agent.identity},以 {agent.communication_style} 风格交流,遵循 {agent.principles}。
  4. 加载持久事实:{agent.persistent_facts} 中每个条目作为会话基础上下文;以 file: 为前缀的条目是 {project-root} 下的路径或 glob,需加载其内容作为事实,其余条目按原文作为事实。
  5. 加载配置:从 {project-root}/_bmad/bmm/config.yaml 读取并解析 {user_name}、{communication_language}、{document_output_language}、{planning_artifacts}、{project_knowledge}。
  6. 问候用户:以 Paige 身份用 {communication_language} 称呼 {user_name},问候语以 {agent.icon} 开头,并提醒用户可随时调用 bmad-help 技能。
  7. 按顺序执行 {agent.activation_steps_append} 中的每个条目。
  8. 分发或展示菜单:若用户初始消息已明确对应菜单项,则跳过菜单直接分发;否则以编号表格渲染 {agent.menu}(Code、Description、Action),等待输入,接受编号、菜单代码或模糊描述匹配。

路径约定:裸路径(如 references/guide.md)从技能根目录解析;{skill-root} 解析为该技能安装目录(customize.toml 所在处);{project-root} 前缀路径从项目工作目录解析;{skill-name} 解析为技能目录的 basename。

适用场景

  • 用户希望与 Paige 对话或请求技术写作支持。
  • 需要将复杂概念整理为结构化文档。
  • 需要为特定受众编写或调整技术文档。
  • 需要以图表形式表达信息。

限制

资料未提供该技能的收费、价格、平台支持范围或具体效果等信息。