「伝わるチケット」でプロジェクト管理をスムーズに！Redmineを見やすくするtextile記法9選
Redmineでプロジェクトを管理しているみなさん、こんにちは。ジェシカです。
あなたが書いたチケット、ちゃんとメンバーに伝わっていますか？
意味不明なチケットや、あとから振り返ると起票者でも記憶を辿るのに時間がかかるチケットなどが乱立していることがよくあります。
情報は書いただけでは意味がなく、相手に正確に伝わって初めて意味があります。
チケットを見たメンバーから「これ、どういう意味ですか？」などと質問がくるうちは、まだ「伝わるチケット」になっていないということです。
チケットは起票後すぐに対応するとは限りません。
あなたが既にプロジェクトから離れていて質問すらできない状況になっているかもしれません。
誰がいつ見ても迷うことなく対応できるのが「伝わるチケット」です。
「伝わるチケット」にするためには、あとからプロジェクトに参加したメンバーでも迷わないように、背景や目的をきちんと書く、可能な限りスクリーンショットを添付するなど気を付けるべきポイントがたくさんあります。
本記事では、少しでもチケットがわかりやすくするために効果的なtextile記法をご紹介します。
最新のバージョンでは、WYSIWYG（ウィジウィグ）で表現できるようになっていますが、まだ古いバージョンを使っているRedmineユーザーは、込み入った説明をする時に、文字だらけで読みづらい体裁にならないよう上手に記法を活用できるといいですね。
文字を強調したい時
該当テキストや文章を、以下の記号で挟んでください。
- 太字にしたい・・・「*太字*」のように、アスタリスクで囲む
- 下線を引きたい・・・「＋下線＋」のように、プラスで囲む
- 斜体にしたい・・・「_shatai_」のように、アンダーバーで囲む。但し、日本語は斜体にできないので注意してください。
他のチケットにリンク
「#チケット番号」で他のチケットにリンクできます。 前後に半角スペースを入れるのを忘れずに。
左側にインデント（スペース）を入れたい時
” p(. ”でインデントを設定できます。
” ( ”の数を増やすことで、インデントの階層を表現できます。
文章の上下には空行を入れましょう。また、ピリオドの後は半角スペースが必要です。
（記法例）
p. 左にインデントを入れない場合
p(. 左にインデントを一文字分入れたい場合
↓ ↓ ↓ ↓
（表示例）
左にインデントを入れない場合
左にインデントを一文字分入れたい場合
リストや番号で箇条書きをきれいに見せたい時
「*」アスタリスクや「#」シャープを使って箇条書きを見やすく整えます。
【リストの場合】
該当のテキストの先頭にアスタリスクと半角スペースを入れましょう。アスタリスクの数によって、表示される記号やインデントが変わります。
【箇条書きの場合】
（記法例）
* カルビー
** じゃがりこ
*** サラダ味
*** チーズ味
↓ ↓ ↓ ↓
（表示例）
●カルビー
◯じゃがりこ
■サラダ味
■チーズ味
【番号の場合】
シャープと半角スペースを入れましょう。シャープの数によってインデントが変わります。
（記法例）
# バラ
# チューリップ
## 赤
##白
### きれい
↓ ↓ ↓ ↓
（表示例）
1. バラ
2. チューリップ
1. 赤
2. 白
1.きれい
見出しをわかりやすくしたい時
h1.からh6.まで使用できます。見出しの先頭に希望のサイズを入力します。ピリオドの後ろに半角スペースを入れることをお忘れなく！
（記法例）
h1. 改修概要
水平線を引きたい時
画面いっぱいに水平線を引きたいときは、「---」のように、ハイフンを３つ並べ、上下は空行にしておきます。HTMLのhr /タグに該当します。
（記法例）
---
↓ ↓ ↓ ↓
（表示例）
リンクをつけたい時
リンクをつけたいテキストを「“」ダブルクォーテーションで囲み、「：」コロンをつけてURLを記載します。URLの末尾には半角スペースを入れます。
（記法例）
"URLはこちら":http://media.coach4pm.com/
↓ ↓ ↓ ↓
（表示例）
URL はこちら
表（テーブル）をつくりたい時
文字列を「｜」（パイプライン）で囲むと表示されます。
（記法例）
|No|国名|首都|
|1|フランス|パリ|
|2|オーストラリア|キャンベラ|
↓ ↓ ↓ ↓
( 表示例)
「_.」アンダーバー＋ピリオドをテキストの前につけると、その行のテーブルヘッダとして太字でセンター表示してくれるので、表が見やすくなります。
（記法例）
|_.No|_.国名|_.首都|
|1|フランス|パリ|
|2|オーストラリア|キャンベラ|
↓ ↓ ↓ ↓
( 表示例)
ソースコードを記載したい時
ソースコードなどの記述や表記を加工せず、そのまま掲載したい場合は、preタグで囲むと、該当のソース箇所を囲って見やすく表示してくれます。
さいごに
textile記法は、半角スペースや文章の前後に空行が必要なことが多いので、「うまく表示されない」時にはこれらがきちんと入っているか確認してください。
文字だけで込み入った内容を伝えることは難しく、相手に誤解を与える内容になってしまう恐れがあります。
一度相手に誤解されると、軌道修正に時間がかかってしまい、プロジェクトの進行に影響を与えかねません。
相手に伝わりやすい、思いやりのあるチケットが作成できるよう、ぜひtextile記法を取り入れてプロジェクトをスムーズに進行させてください！
★Redmineの活用についてはこちらの記事もオススメです。★
