用途:帮助以编程方式创建、理解和校验 Jira 富文本所用的 ADF(Atlassian Document Format)JSON,也用于排查 Jira API 的 ADF 报错。
主要能力:ADF 采用严格层级结构,根节点 doc 含 version、type、content,下分块级节点(标题、段落、列表、面板、代码块、表格)、行内节点(文本、emoji、链接、提及)与 marks(加粗、斜体、行内代码、删除线、链接);遵循单一顺序路径,线性遍历即为正确阅读顺序。提供三种构建方式:JiraDocumentBuilder(推荐,链式 API,自动处理嵌套)、EpicBuilder / IssueBuilder(标准化模板)、原始 ADF 字典(完全控制,适合复杂布局)。支持标题、段落、列表、代码块、面板(info/note/warning/success/error)、分隔线、emoji 及多种行内格式。校验可使用 Atlassian 官方 JSON Schema,或运行脚本 python .claude/skills/work-with-adf/scripts/validate_adf.py your-adf.json。
必要用法:先理解 ADF 结构,再选择构建方式,调用 doc.build() 得到 ADF,可直接传给 Jira API(如 client.create_issue(..., description=adf_dict))。常见错误包括块节点缺少 content、缺少 version、嵌套非法、缺少 attrs;可打印 JSON、检查嵌套、逐段构建来排查。
适用场景:程序化生成 Epic / Issue 描述、评论富文本、标准化文档模板、调试 Jira API 校验错误。
限制:需 Python 3.8+、jira-tool 包、JSON 结构知识及具备 Cloud API 访问权限的 Jira 实例。具体安装命令、版本与收费信息资料暂未提供。