みなさんは、Redmineのリンクを上手く活用できていますか?
リンクと一口に言っても、Redmineではさまざまな書き方があります。
「RedmineでURLを張りたいけど、どうやって書けばいいんだろう…」
「Redmineでチケット間の関連性がわかるようにしたいけど、どうすればいいんだろう…」
「RedmineでWikiページへのリンクをチケットに貼りたいけど、どうすればいいんだろう…」
といった、リンクにまつわる悩みを持っている方も多いのではないでしょうか。
そこで今回は、
・Redmineで使えるリンクの種類
・Redmineのリンクの書き方
・合わせて覚えると便利なRedmineのWiki記法
について解説します!
Redmineのリンクの種類について
最初に、Redmineのリンクの種類について解説します。
Redmineでは、大きく分けて次の4つのリンクがあります。
- URLのリンク
- 注記へのリンク
- 別チケットへのリンク
- Wikiページへのリンク
リンクと一口に言っても、さまざまな使い方があるのです。
また、リンクを使いこなすと、次のようなメリットもあります。
- 情報共有が効率的にできる
- コミュニケーションがとりやすくなる
- チケット間の連携が確認しやすくなる
とても便利な使い方ができるので、リンクの使い方を覚えておくのがおすすめです!
Redmineのリンクの書き方とは?
次に、Redmineのリンクの書き方について、解説します。
URLのリンク
まずは、「URLのリンクを作る方法」についてです。
URLのリンクイメージ:
このように、参考WebページなどのURLをリンクにしたい場合に使います。
作り方
URLのリンクを作る場合は、URLの前後に「半角スペース」を入れます。
書き方サンプル:
誤った書き方⇒Redmine Wiki記法:https://www.sejuku.net/blog/80032 正しい書き方⇒Redmine Wiki記法: https://www.sejuku.net/blog/80032
見え方のイメージ:
このように、「半角スペース」を前後に入れるだけで簡単にリンクにすることができます。
注記へのリンク
次に、「注記へのリンクを作る方法」について解説します。
注記とは、チケットごとにコミュニケーションをとるための、コメントのことです。
具体的なやり取りが履歴で残せるため、とても便利な機能ですね。
ただ、やり取りしていく中で「新しいチケット」を作ったほうが良いケースも出てくると思います。
たとえば、次のようなケースですね。
・新しいチケットが必要になる例:
このような場合、「チケットを作った経緯」をわかりやすくするために、「注記へのリンク」をチケットの「説明」に追加するケースがよくあります。
どんどん下に会話が流れていくことも多いため、「注記へのリンクを作る方法」を覚えておくと便利です!
作り方
注記へのリンクは、「チケットのURL + #note- + 注記番号」のように作ります。
たとえば、チケットのURLが「http://localhost/redmine/issues/2」、注記番号が「6」だった場合は、次のようになります。
書き方サンプル:
http://localhost/redmine/issues/2#note-6
実際のイメージ:
Redmineを使うチームの人数が多くなればなるほど、注記は埋もれていきます。
重要な注記が見つかった時は、注記リンクを作っておくだけでも運用が楽になるので、使い方を覚えておくと便利です!
別チケットへのリンク
次に、「別チケットへのリンクを作る方法」について解説します。
チケットは単体のみで使うケースもありますが、「チケット1が終わったら、チケット2を対応」「過去に対応したチケット20と、新しく見つかったバグが似ている」というように、関連するチケットをわかりやすくメモしておきたいケースがよくあります。
そんなときにおすすめなのが、「別チケットへのリンク」です
別チケットへのリンクイメージ:
肝となるリンクの一つなので、使い方を覚えておくと便利です!
作り方
別チケットへのリンクは、 「#チケット番号」の前後に「半角スペース」をつけて、作ります。
書き方サンプル:
■過去に対応した類似チケット一覧 ・【バグ】CSVインポート機能の桁あふれ: #3 ・【バグ】CSVインポート機能の出力文字化け: #7
実際のイメージ:
Redmineに「関連するチケット」という機能もありますが、Redmineは使い方が浸透するまでが大変なので、簡単に作れる別チケットへのリンクの作り方を覚えておくと便利です!
Wikiページへのリンク
次に、「Wikiページへのリンクを作る方法」について解説します。
Redmineには、文章をまとめておくことができるWikiページがあります。
Wikiページは、「Redmineの運用ルール」「RedmineのWiki記法」などのマニュアルをまとめるために使ったり、「頻度の高い問い合わせ一覧」のように、運用しやすくするための機能としてとても便利です。
作成したWikiページは、次のようにチケット作成時に補足としてリンクするケースがよくあります。
Wikiページへのリンクイメージ:
情報共有しやすくなるので、使い方を覚えておくと便利です!
作り方
Wikiページへのリンクは、「Wikiページをそのまま表示する場合」「プロジェクトを指定する場合」「見出しを指定する場合」「リンクの表示文字を変更する場合」など、それぞれ書き方が違います。
Wikiページへのリンクの書き方:
・Wikiページのみ:[[Wikiページ名]] ・Wikiページのみ(表示名変更):[[Wikiページ名|表示名]] ・プロジェクト + Wikiページ:[[プロジェクト名:Wikiページ名]] ・Wikiページ + 見出し:[[Wikiページ名#見出し名]]
これだけではわかりにくいので、サンプルを用意しました。
書き方サンプル:
・Wikiページのみ:[[Redmine運用ルール]] ・Wikiページのみ(表示名変更):[[Redmine運用ルール|Redmineルール]] ・プロジェクト + Wikiページ:[[Webアプリ開発:Redmine運用ルール]] ・Wikiページ + 見出し:[[Redmine運用ルール#チケット作成のルール]]
実際のイメージ:
最低限、Wikiページに直接リンクする方法は覚えておくのがおすすめです!
それ以外の書き方は、「RedmineのWikiページ」に載せて、いつでも見れるようにしておくのがおすすめです!
合わせて覚えると便利なRedmine記法まとめ
ここまで、Redmineのリンクの種類・具体的な使い方について解説してきました。
ただ、Redmineにはリンク以外にも覚えておくと便利な書き方がたくさんあります。
Redmineでコミュニケーションがしやすくなるので、興味がある方はぜひ見てみてくださいね!
まとめ
今回は、Redmineのリンクの種類・具体的な使い方について徹底的に解説しました。
今回お伝えした方法をマスターすれば、Redmineでコミュニケーションがしやすくなります。
どれも簡単なので、ぜひ使ってみてくださいね!