Redmineでは、チケットコメントやWikiでMarkdown記法が使えます。
ただのテキスト入力よりも見やすく、チーム内の情報共有が格段にスムーズになります。
この記事では、Redmineのコメントで使える代表的なMarkdown書式をまとめて紹介します。
🔹 Markdownの基本ルール
Redmineの設定で「テキスト書式」が Markdown になっている場合に使用可能です。
管理者設定から [管理] > [設定] > [全般] > [テキスト書式] で確認しましょう。
📘 よく使うMarkdown記法一覧
| 目的 | 記法例 | 表示例 |
|---|---|---|
| 見出し | # タイトル | タイトル |
| 強調 | **重要** | 重要 |
| 斜体 | *補足* | 補足 |
| 打ち消し | ~~不要~~ | 不要（取り消し線） |
| 箇条書き | - 項目1 - 項目2 | ・項目1 ・項目2 |
| 番号付きリスト | 1. 手順A 2. 手順B | 1. 手順A 2. 手順B |
| 引用 | > メモ内容 | メモ内容（引用表示） |
| コードブロック | ```java System.out.println("Hello"); ``` | コード枠付きで表示 |
| リンク | [Redmine公式](https://www.redmine.org/) | Redmine公式へのリンク |
| 画像 |  | 画像を表示 |
| 水平線 | --- | 水平線が引かれる |
| チェックリスト | - [x] 完了 - [ ] 未完了 | ☑ 完了／□ 未完了 |
💡 コメントを見やすくするテクニック
1. 見出しで構造化
### 問題の詳細### 再現手順### 対応方針
といった形で区切ると、レビューする側がすぐに内容を把握できます。
2. コードやログは囲む
Redmineはコードハイライトに対応しているため、
のように書くと、整ったコードブロックで表示されます。
3. 引用でメッセージのやりとりを整理
前回のコメント引用
対応方針を確認しました。
このように相手の発言を引用してから返信すると、会話の流れが分かりやすくなります。
4. リンクで関連チケットを明示
-
[チケット#123](https://redmine.example.com/issues/123) -
#123とだけ入力しても自動リンクされる
🧩 Redmine特有の便利書式
| 機能 | 記法例 | 説明 |
|---|---|---|
| チケット参照 | #123 | 該当チケットにリンク |
| 添付ファイルリンク | attachment:log.txt | 添付済みファイルを参照 |
| Wikiページ参照 | [[Wikiページ名]] | Wiki内リンク |
| メンション | @ユーザー名 | 通知を送る（設定による） |
🌟 まとめ
| ポイント | 内容 |
|---|---|
| 構造化 | 見出しと箇条書きで整理 |
| 明確化 | 引用とリンクで文脈を共有 |
| 強調 | 太字・斜体で重要箇所を目立たせる |
| 見やすさ | コードや表を活用して情報を整理 |
Markdownを使いこなせば、Redmineのコメントは「読む」ものから「伝わる」ものへ進化します。
特に開発・運用チームでは、ログ・SQL・設定内容をコードブロックで整えるだけでも大幅に改善できます。