jira-syntax

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Jira Syntax

Jira语法

Jira wiki markup syntax, templates, and validation. For API operations, use the jira-communication skill.

Jira wiki标记语法、模板和验证。如需API操作，请使用jira-communication技能。

Quick Syntax Reference

快速语法参考

Jira Syntax	Purpose	NOT this (Markdown)
`h2. Title`	Heading	`## Title`
`bold`	Bold	`bold`
`_italic_`	Italic	`italic`
`{{code}}`	Inline code	`code`
`{code:java}...{code}`	Code block	java ```
`[text\|url]`	Link	`[text](url)`
`[PROJ-123]`	Issue link	-
`[~username]`	User mention	`@username`
`* item`	Bullet list	`- item`
`# item`	Numbered list	`1. item`
`\|\|Header\|\|`	Table header	`\|Header\|`

See

references/jira-syntax-quick-reference.md

for complete syntax documentation.

Jira语法	用途	请勿使用（Markdown语法）
`h2. Title`	标题	`## Title`
`bold`	加粗	`bold`
`_italic_`	斜体	`italic`
`{{code}}`	行内代码	`code`
`{code:java}...{code}`	代码块	java ```
`[text\|url]`	链接	`[text](url)`
`[PROJ-123]`	问题链接	-
`[~username]`	用户提及	`@username`
`* item`	无序列表	`- item`
`# item`	有序列表	`1. item`
`\|\|Header\|\|`	表头	`\|Header\|`

完整语法文档请查看

references/jira-syntax-quick-reference.md

。

Available Templates

可用模板

Bug Report

Bug报告模板

Path:

templates/bug-report-template.md

Sections: Environment, Steps to Reproduce, Expected/Actual Behavior, Error Messages, Technical Notes

路径:

templates/bug-report-template.md

包含章节：环境信息、复现步骤、预期/实际行为、错误信息、技术说明

Feature Request

功能需求模板

Path:

templates/feature-request-template.md

Sections: Overview, User Stories, Acceptance Criteria, Technical Approach, Success Metrics

路径:

templates/feature-request-template.md

包含章节：概述、用户故事、验收标准、技术方案、成功指标

Syntax Validation

语法验证

Run before submitting to Jira:

bash

${CLAUDE_SKILL_DIR}/scripts/validate-jira-syntax.sh path/to/content.txt

提交到Jira前请运行以下命令：

bash

${CLAUDE_SKILL_DIR}/scripts/validate-jira-syntax.sh path/to/content.txt

Validation Checklist

验证检查清单

Headings:
```
h2. Title
```
(space after period)
Bold:
```
*text*
```
(single asterisk)
Code blocks:
```
{code:language}...{code}
```
Lists:
```
*
```
for bullets,
```
#
```
for numbers
Links:
```
[label|url]
```
or
```
[PROJ-123]
```
Tables:
```
||Header||
```
and
```
|Cell|
```
Colors:
```
{color:red}text{color}
```
Panels:
```
{panel:title=X}...{panel}
```

标题：
```
h2. Title
```
（句号后需加空格）
加粗：
```
*text*
```
（单个星号）
代码块：
```
{code:language}...{code}
```
列表：无序列表用
```
*
```
，有序列表用
```
#
```
链接：
```
[label|url]
```
或
```
[PROJ-123]
```
表格：表头用
```
||Header||
```
，单元格用
```
|Cell|
```
颜色：
```
{color:red}text{color}
```
面板：
```
{panel:title=X}...{panel}
```

Common Mistakes

常见错误

❌ Wrong	✅ Correct
`## Heading`	`h2. Heading`
`bold`	`bold`
`code`	`{{code}}`
`[text](url)`	`[text\|url]`
`- bullet`	`* bullet`
`h2.Title`	`h2. Title`

❌ 错误写法	✅ 正确写法
`## Heading`	`h2. Heading`
`bold`	`bold`
`code`	`{{code}}`
`[text](url)`	`[text\|url]`
`- bullet`	`* bullet`
`h2.Title`	`h2. Title`

Integration with jira-communication Skill

与jira-communication技能集成

Workflow:

Get template from jira-syntax
Fill content using Jira wiki markup

Validate with

${CLAUDE_SKILL_DIR}/scripts/validate-jira-syntax.sh

Submit via jira-communication skill

工作流程:

从jira-syntax获取模板
使用Jira wiki标记填充内容

运行

${CLAUDE_SKILL_DIR}/scripts/validate-jira-syntax.sh

进行验证

通过jira-communication技能提交

References

参考资料

references/jira-syntax-quick-reference.md

- Complete syntax documentation

references/cross-project-refs.md

- GitLab cross-project ref convention (

group/project!N

group/project#N

group/project@tag

) when linking to GitLab from Jira

```
templates/bug-report-template.md
```
- Bug report template
```
templates/feature-request-template.md
```
- Feature request template

${CLAUDE_SKILL_DIR}/scripts/validate-jira-syntax.sh

- Automated syntax checker

Official Jira Wiki Markup

references/jira-syntax-quick-reference.md

- 完整语法文档

references/cross-project-refs.md

- 从Jira链接到GitLab时的跨项目引用规范（

group/project!N

group/project#N

group/project@tag

）

```
templates/bug-report-template.md
```
- Bug报告模板
```
templates/feature-request-template.md
```
- 功能需求模板

${CLAUDE_SKILL_DIR}/scripts/validate-jira-syntax.sh

- 自动化语法检查工具

Official Jira Wiki Markup