jira-syntax について
Jira wiki markup を書く人向けの構文リファレンス兼検証スキルです。書式、テンプレート、自動チェックを扱い、API 操作は jira-communication スキルが担当します。
主な機能
- 01Jira wiki markup リファレンス
- 02テンプレートと検証チェックリスト
- 03スクリプトによる構文チェック
- 04よくある誤りの例
- 05GitLab のプロジェクト間参照規約
活用シーン
- 01Jira の課題内容の作成
- 02投稿前の wiki markup 検証
- 03不具合・機能要望テンプレートの作成
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ netresearch/ jira-skill --skill jira-syntaxインストール後、Claude Code で/jira-syntaxを入力して読み込まれたか確認します。
同梱ファイル
SKILL.md と一緒にインストールされる参考資料やスクリプト。
AGENTS.mdevals/evals.jsonreferences/cross-project-refs.mdjira-syntax-quick-reference.mdscripts/validate-jira-syntax.shtemplates/bug-report-template.mdfeature-request-template.md詳細
Jira 構文
Jira の Wiki マークアップ構文、テンプレート、検証について説明します。API 操作には、jira-communication スキルを使用してください。
クイック構文リファレンス
| 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 を参照してください。
利用可能なテンプレート
バグ報告
パス:templates/bug-report-template.md
セクション:環境、再現手順、期待される動作/実際の動作、エラーメッセージ、技術的な注意事項
機能リクエスト
パス:templates/feature-request-template.md
セクション:概要、ユーザーストーリー、受け入れ基準、技術的なアプローチ、成功指標
構文の検証
Jira に送信する前に実行してください:
${CLAUDE_SKILL_DIR}/scripts/validate-jira-syntax.sh path/to/content.txt
投稿のゲートとして機能します。独立した手順として実行し、投稿コマンドと連結しないでください。
検証チェックリスト
- 見出し:
h2. Title(ピリオドの後にスペースを入れる) - 太字:
*text*(アスタリスクは1つ) - コードブロック:
{code:language}...{code} - リスト:箇条書きには
*、番号付きには# - リンク:
[label|url]または[PROJ-123] - 表:
||Header||と|Cell| - 色:
{color:red}text{color} - パネル:
{panel:title=X}...{panel}
よくある間違い
| ❌ 誤り | ✅ 正しい |
|---|---|
## Heading | h2. Heading |
**bold** | *bold* |
`code` | {{code}} |
[text](url) | [text|url] |
- bullet | * bullet |
h2.Title | h2. Title |
MR !42(GitLab の参照を単独で記述) | [MR 42|url] または完全な group/project!42 — !…! を単独で記述すると画像マークアップになります |
オープン/提案中の項目に (/) | (x) — (/) は緑色のチェック(完了)として表示されます。オープンの項目には (x) を使用してください |
チェックボックスとして ( ) | (x) — ( ) はマクロではなく、そのまま表示されます |
レビュー中の保留ステップに (-) または (x) | (i) pending: … — (-) は赤い進入禁止標識として表示され、レビュー中の (x) は失敗を意味します |
jira-communication スキルとの連携
ワークフロー:
- jira-syntax からテンプレートを取得する
- Jira Wiki マークアップを使って内容を記入する
${CLAUDE_SKILL_DIR}/scripts/validate-jira-syntax.shで検証する- jira-communication スキルを使って送信する
参考資料
references/jira-syntax-quick-reference.md- 構文の完全な説明
推測する代わりにレンダラーに確認する方法も含まれています。POST /rest/api/1.0/renderは、マークアップを投稿する前に、任意のマークアップから Jira が生成する HTML を返します。マークアップについて疑問がある場合は、答えを推測するのではなく、これを使って確認してください。references/cross-project-refs.md- Jira から GitLab へのリンクに使用する、GitLab のプロジェクト間参照規約(group/project!N、group/project#N、group/project@tag)templates/bug-report-template.md- バグ報告テンプレートtemplates/feature-request-template.md- 機能リクエストテンプレート${CLAUDE_SKILL_DIR}/scripts/validate-jira-syntax.sh- 自動構文チェッカー- 公式 Jira Wiki マークアップ
コメント
Markdown 対応