開発Divの藤原です。
Keepdata社内ではタスク管理にRedmineを使用しています。社内でのRedmine使用頻度は一二を争う私ですが、チケットの記述方法次第で内容の理解度や理解するスピードには結構影響があると感じています。つまりは情報を分かり易く書くことで業務の効率化につながる(はず)。その中でもよく使う便利な記述方法についてご紹介します。
※テキスト書式がMarkdownのときの記述法です。Redmineのバージョンによっては使えないものがあるかもしれません。
インライン表示
強調したい文章やソースコード等を記述する際に使います。あとはログの抜粋でつかうのも有効です。
```
あいうえお
かきくけこ
```
ソースコードの場合は先頭に言語を記載すると、対応している言語であれば文字色を自動で変換してくれます。
```javascript
let a = "hoge";
alert(a);
```
引用
インラインと似ていますが、こちらは入れ子が使えます。メール(メーラー)でよく使われている引用と同じですね。
>>> おはよう!
>> おはよう!!
> おはよう!!!
目次
{{toc}}と書くだけで、見出しの目次を作ってくれます。もちろんクリックすると該当の見出しにジャンプします。
{{toc}}
# 見出し1
## 見出し1-1
### 見出し 1-1-1
#### 見出し 1-1-1-1
## 見出し 1-2
# 見出し2
## 見出し2-1
区切り線
ハイフンを3つ繫げます。内容を区切りたいときに有効です。
上
---
下
折りたたみ
長いログや長い文章の転記などを記載する場合に有効です。
{{collapse(表示, 隠す)
あいうえお
かきくけこ
さしすせそ
}}
クリックすると、表示されます。もう一度クリックすると隠れます。「表示」「隠す」の文言は変更可能です。
添付ファイルリンク
チケットに添付したファイルへのリンクを表示します。例えば、コメントの中にこの記載を用いることでコメントと添付ファイルの関連が分かり易くなります。
attachment:file.zip
ファイル名に_(アンダースコア)が含まれている場合は、_(アンダースコア)の前に \(バックスラッシュ、円マーク)を付けて "(ダブルクォーテーション)でファイル名を括ります。
attachment:"file\_1.zip"
添付画像サムネイル表示
添付ファイルのリンクをクリックすることなく画像が表示され便利です。表示するサイズも変更可能です。
{{thumbnail(logo.png, size=500)}}