SuperAPI AI 工具集

build-jira-document-format

办公与效率

查看项目

更新于 10-15 20:34

技能介绍

用途:掌握 Atlassian Document Format 的高级模式,程序化生成结构复杂、可复用的 Jira 文档,并在多个 issue/epic 间保持一致格式。

主要能力:提供 JiraDocumentBuilder 通用构建器,支持标题、段落、分隔线、无序/有序列表、代码块(带语言)、面板(info/note/warning/success/error)及粗体、斜体、行内代码、删除线、链接等文本格式,可组合混合内容。提供 EpicBuilder、IssueBuilder 等专用模板,并支持通过继承、组合与辅助函数扩展自定义布局。

使用方式:需 Python 3.10+ 及包含上述构建器的 jira_tool.formatter 模块。典型用法为实例化构建器后链式调用,例如 JiraDocumentBuilder().add_heading(...,1).add_bullet_list([...]),最后调用 build() 得到 ADF。提交到 Jira 需 REST API v3 访问及 JIRA_BASE_URL、JIRA_USERNAME、JIRA_API_TOKEN 环境变量。可用 npm install -g jira-adf-validator 验证结构。

适用场景:反复手工创建相似 Jira 文档、需要统一格式、以工具批量生成 Jira 内容、构建含代码块与嵌套面板的复杂文档,或调试 ADF 结构问题。

限制:ADF 需满足 version:1、type:"doc" 与 content 数组;面板须包含内容节点;链式调用要求方法返回 self;建议每次新建构建器实例并在 build() 中校验;具体模板实现与测试策略详见 references/advanced-patterns.md 与 examples/epic-examples.md。