Jira Syntax 是一个专注于 Jira wiki 标记语法的技能,适用于编写或格式化 Jira 描述、评论以及其他要提交到 Jira 的文本。它的主要用途是把 Markdown 习惯转换为 Jira 可识别的 wiki 标记,并提供模板与验证手段,减少因语法差异导致的内容渲染错误。
主要能力包括:
-
Jira wiki 标记速查。资料中列出了用途与对应写法,例如标题用 h2. Title(而不是 Markdown 的 ## Title);粗体用 bold(不是 bold);斜体用 italic(不是 italic);内联代码用 {{code}}(不是
code);代码块用 {code:java}...{code}(而不是三反引号加 java);链接用 [text|url](不是 text);议题链接用 [PROJ-123];用户提及用 [~username](不是 @username);项目符号用 * item(不是 - item);编号列表用 # item(不是 1. item);表头用 ||Header||、单元格用 |Cell|。颜色用 {color:red}text{color},面板用 {panel:title=X}...{panel}。完整语法文档位于 references/jira-syntax-quick-reference.md。 -
模板。提供 Bug 报告模板(路径 templates/bug-report-template.md),包含环境、重现步骤、预期与实际行为、错误信息、技术备注等章节;提供功能请求模板(路径 templates/feature-request-template.md),包含概述、用户故事、验收标准、技术方案、成功指标等章节。
-
语法验证。提交到 Jira 前可运行 ${CLAUDE_SKILL_DIR}/scripts/validate-jira-syntax.sh path/to/content.txt 进行自动检查。资料强调该验证应作为独立步骤执行,不要与提交命令串联。验证清单覆盖标题、粗体、代码块、列表、链接、表格、颜色、面板等写法。
-
常见错误对照。资料给出了若干需要注意的差异,例如不应使用 (/) 表示待办或提议项,因为 (/) 渲染为绿色对勾表示已完成,待办项应使用 (x);不应把 ( ) 当复选框,因为它不是宏,会按字面渲染,应使用 (x);在评审的待处理步骤上不应使用 (-) 或 (x),因为 (-) 渲染为红色禁止标志,而评审中 (x) 表示失败,待处理应使用 (i) pending: …。另外不要把裸的 GitLab 引用如 MR !42 直接写入,因为裸的 !…! 是图片标记,应写成 [MR 42|url] 或完整的 group/project!42。
-
渲染验证建议。资料建议“询问渲染器而不是自行推理”:POST /rest/api/1.0/render 会返回 Jira 将生成的 HTML,可在发布前用它确认标记问题。
使用方式:资料给出的工作流是先从 jira-syntax 获取模板,使用 Jira wiki 标记填写内容,再用验证脚本检查,最后通过 jira-communication 技能提交。该技能本身不负责 API 操作,API 操作交由 jira-communication 技能处理。
适用场景:需要撰写 Jira 议题描述、评论,或从 Markdown 迁移内容到 Jira 时,可用它做语法转换、模板填充和提交前检查。
限制:资料未提供安装命令、具体脚本实现细节、是否收费或授权方式、支持的 Jira 版本范围等信息,这些暂未提供。资料也未说明模板字段是否可自定义、验证脚本的完整错误码或返回格式。