用途:该技能面向红帽开发者中心(RHDH)功能文档编写,把 Jira 功能、关联 PR 与现有文档作为输入,产出可直接提交的文档内容,而不是文档规划元文档或分析报告。
主要能力:
- RHDH 产品文档(默认,AsciiDoc):新功能生成完整结构,包括主装配文件、概念模块(con-.adoc)、过程模块(proc-.adoc)、参考模块(ref-*.adoc),并处理属性、交叉引用与 include;已有功能则给出要更新的文件、要增改的章节内容、需新建的模块及交叉引用更新。
- 发布说明内容:判定发布说明类型(Feature、Enhancement、Bug Fix 等),生成 5-10 词的面向用户标题、1-3 段描述、必要时的 Action required 章节,以及破坏性变更的迁移/升级说明。
- TechDocs(Backstage 插件文档,Markdown):生成 mkdocs.yml 以及 docs/index.md、installation.md、configuration.md、usage.md 等文件,按需补充 api.md、troubleshooting.md、migration.md。先询问插件现有 TechDocs 目录:提供目录则进入更新模式,只改与该功能相关的页面;不存在则进入创建模式,为功能所属的整个插件编写端到端文档。
- 文档更新摘要(分析模式):仅列出需更新的现有文档路径、需新增的文档、现有文档缺口与建议结构,不产出实际内容。
使用方式:需要 acli(Atlassian CLI)并完成 Jira 认证,可通过 python3 "$SKILL/scripts/setup_acli.py" 验证配置;可选 gh CLI 与 Python 3.7+。脚本位于技能自身 scripts/ 目录,模板位于 references/,需先解析技能根目录而非硬编码安装路径。生成内容写入当前工作目录下的 ./rhdh-feature-docs-output/<ISSUE-KEY>/。流程为:定位现有 TechDocs(仅 TechDocs 模式)→ 用 jira_acli.py 抓取工单信息(含子项)→ 用 --pull-requests 收集 PR 链接并分析 PR 描述、提交、受影响的文档与配置文件 → 对照 references/rhdh-docs-structure.md 判断文档归属章节,并用 fetch_rhdh_docs.py 检索现有文档。PR 发现会合并远端/网页链接与工单内容中的链接;JIRA_API_TOKEN 仅从环境变量读取,不得打印。TechDocs 更新模式下可在用户许可时直接写入本地仓库,但要求工作树干净、处于功能分支,且不提交、不推送。
适用场景:用户给出 redhat.atlassian.net 的 Jira 功能/问题链接并希望生成文档内容;要求"为这个功能写文档";需要发布说明或 TechDocs;功能负责人希望得到可直接使用的 AsciiDoc 文档;文档团队需要符合 RHDH 结构的实际文档。
限制:不产出文档规划类元文档、文档工作的项目管理文档或无实际内容的分析报告;未提供具体收费、价格与平台要求信息,暂未提供。