はじめに
QualityForwardはプロジェクトごとに管理できるWiki機能をサポートしています。
記述にはMarkdown記法*1を採用しており、各ページにファイルを添付することが可能です。
テスト機材の環境構築の手順書や、テストの運用ルール、不具合の登録方法など、その他にもプロジェクトごとに手順が変わるものや全員に共有しておきたい内容などをWikiページにまとめておくことで、情報が一元管理できるようになります。
基本的な使い方
チームWikiで良く利用される基本的な書き方と、各操作方法をご紹介します。
より詳細な情報が知りたい場合は、編集ページの右上にある「ヘルプ」をご確認してください。
チームWikiのルートページ
プロジェクトの左側メニューにある「チームWiki」をクリックすると最初にルートページが表示されます。 必要な情報にたどり着けるよう、このルートページに各ページのリンクをまとめていきましょう。
ページを追加する
新しくWikiページを作成したい場合には、ページ一覧から「ページの追加」が可能です。
ページに目次を追加する
右側の目次は「見出し」のレベルに合わせて自動生成されます。
# 見出し1
## 見出し2
### 見出し3
このように、見出しには段落をつけることも可能です
ページにファイルを添付する
編集ページから、ドラッグ＆ドロップでファイルを添付できます。
不具合の下書き用ファイルや、議事録テンプレートなどを添付するのに便利です。
他にも、ページに画像を載せたい場合には、画像ファイルを添付することでリンクを取得できます。
ページに色々なコンテンツを載せる
画像を載せる
画像は以下の記法で載せることができます。
画像ファイルはページに添付することで、リンクを取得できます。
ファイルの添付方法はこちら
リンクを載せる
リンクは以下の記法で載せることができます。
[リンク](リンクURL)
見出しをリンクに指定することでページ内リンクにすることもできます。
テーブルを載せる
Markdownで表を載せることもできます。
他の方法としては、VS codeの拡張機能「Excel to Markdown table」でExcelで書いた表をMarkdownに変換するのが手軽でお勧めです。
チームWikiの運用にあたって
プロジェクトリーダー・テスト実行者・テスト設計者でそれぞれWikiに載せたい情報が違うかもしれません。Wikiページを運用する際には、一度プロジェクトメンバーでWikiに載せたい情報を共有しましょう。
＜例＞
- 新メンバー向けのリンク各種
- プロジェクトの目的・期間
- 組織図
- 議事録
ページの構成を考える
メンバー全員でページを作成してしまうと、どこに何の情報が書かれているか分からなくなってしまいます。まずは全体のぺージの構成を考え、そのルールに沿って各メンバーが更新できるようにしましょう。
最終更新日を記載する
ページの先頭または末尾に最終更新日を記載しましょう。
情報が古くなっている場合、更新日を見ることでその情報が更新されているか確認ができます。
まとめ
チームwikiに情報を集約することで、今まで個別に説明していた内容や、他のメールで埋もれて見つけるのが難しくなっていた情報を見やすい状態でメンバーと共有することが出来るようになります。
*1:Markdown記法：見出しや箇条書き、リンクなど簡単に文字の装飾を追加できる記法です。簡単な記法を覚えるだけで、リッチな装飾を追加することができるためQiitaやはてなブログにも利用されています。