Wiki
Wiki はプロジェクト単位でナレッジを蓄積・共有するためのドキュメント管理機能です。階層構造によるページ整理、タグ・キーワード検索、バージョン履歴管理など、チームの情報共有を効率化する機能を提供します。
画面構成
メイン画面
Wiki のメイン画面は以下の3つのエリアで構成されています。
| エリア | 説明 |
|---|---|
| プロジェクト選択 | Wiki を表示するプロジェクトを切り替えます |
| ページツリー | 階層構造で整理されたページ一覧を表示します |
| 最近の更新 | 最近作成・更新されたページを時系列で確認できます |
詳細画面
選択したページの本文を表示します。ページのタグ、最終更新者・更新日時、バージョン履歴へのリンクも確認できます。
ページツリー
Wiki のページはツリー構造で管理されます。親ページの下に子ページを作成することで、情報を階層的に整理できます。
ツリーの操作
- フォルダアイコンのページをクリックすると、子ページの一覧を展開・折りたたみできます
- ページ名をクリックすると詳細画面に遷移します
- ツリー上部の「新規作成」ボタンから、ルートレベルまたは任意の親ページ配下にページを追加できます
ページの検索・絞り込み
キーワード検索
ページツリー上部の検索ボックスにキーワードを入力すると、ページタイトルおよび本文を対象にリアルタイムで絞り込みを行います。
タグ検索
各ページに設定されたタグを使ってフィルタリングできます。タグ一覧から対象のタグをクリックすると、そのタグが付いているページのみ表示されます。複数のタグを選択すると AND 条件で絞り込まれます。
ページの作成
- メイン画面右上の「新規作成」ボタンをクリックします
- 作成フォームが開きます
- 以下の項目を入力します
| 項目 | 説明 |
|---|---|
| タイトル | ページの名前(必須) |
| 親ページ | 階層構造の親となるページを選択します。未選択の場合はルートレベルに作成されます |
| タグ | ページに関連するタグを入力します。複数設定可能です |
| ステータス | 下書き または 公開 を選択します |
| 本文の形式 | リッチテキスト または Markdown を選択します。初期値はプロジェクトの「Wiki の既定の形式」(未設定ならリッチテキスト)です。作成後は変更できません |
| 本文 | 選んだ形式でコンテンツを記述します |
- 入力が完了したら「保存」をクリックします
本文の形式(リッチテキスト / Markdown)
| 形式 | 入力方法 | 向いている用途 |
|---|---|---|
| リッチテキスト | ツールバー付きのエディタで、見た目を確認しながら書きます | 画像を貼り込む手順書・お知らせなど |
| Markdown | # 見出し・- 箇条書きなどの Markdown 記法で書きます。「プレビュー」タブで表示を確認できます | 他のツールで書いた Markdown の転記、コードや表の多い技術メモなど |
Markdown では次の記法が表示に反映されます。
- 見出し(
#〜######)。見出しから目次が作られます - 箇条書き・番号付きリスト
- コード(
`インライン`と```で囲んだブロック) - 表(
| 列1 | 列2 |の形式) - リンク(
[表示名](URL))。他の Wiki ページへのリンク([表示名](/v1/wiki/detail/ページID))はリンク先のページの「被リンク」にも表示されます
新しいページの「本文の形式」の初期値は、プロジェクトごとにタスク設定の「Wiki の既定の形式」で変えられます。
本文の形式はページを作った後には変更できません。編集画面ではページの形式に合ったエディタが開き、Markdown のページは保存しても Markdown のまま保たれます。
安全のため、Markdown 中に書いたスクリプトや javascript: で始まるリンクは表示されません。
ステータスについて
- 下書き(Draft): 自分のみ閲覧可能な状態です。作成途中のページを一時保存するときに使用します
- 公開(Published): プロジェクトメンバー全員が閲覧できる状態です
ページの編集
- 詳細画面右上の「編集」ボタンをクリックします
- 編集フォームが開きます
- タイトル、タグ、ステータス、本文を編集します
- 「保存」をクリックして変更を確定します
保存のたびに新しいバージョンが自動的に記録されます。
バージョン履歴
履歴の確認
- 詳細画面の「バージョン履歴」リンクをクリックします
- バージョン一覧画面が開きます
- 各バージョンの更新日時・更新者・変更概要が一覧で表示されます
過去のバージョンの閲覧
バージョン一覧の任意の行をクリックすると、そのバージョン時点での本文を閲覧できます。現在の公開バージョンとの差分を確認しながら内容を比較できます。Markdown のページでは、記法を含む Markdown の原文どうしで差分を表示します。
バージョンの復元
過去のバージョンの詳細画面から「このバージョンに戻す」ボタンをクリックすると、選択したバージョンの内容を現在のページに復元できます。復元操作も新しいバージョンとして記録されます。
プロジェクトとの連携
Wiki はプロジェクト単位でスコープが分かれています。
- メイン画面上部のプロジェクト選択から、参照するプロジェクトを切り替えます
- ページの作成・編集は、選択中のプロジェクトに紐づいて保存されます
- 別プロジェクトのページを閲覧する場合は、プロジェクトを切り替えてください
最近の更新
メイン画面の「最近の更新」セクションでは、現在選択中のプロジェクトで直近に作成・更新されたページが時系列で表示されます。ページ名をクリックすると詳細画面に遷移します。チームメンバーの活動状況の把握や、最新情報へのクイックアクセスにご活用ください。
運用のヒント
階層設計のポイント
- 大分類(例:設計書、手順書、FAQ)をルートページとして作成し、その配下に詳細ページを整理するとツリーが見やすくなります
- 階層が深くなりすぎると検索性が下がるため、3〜4階層を目安にすることを推奨します
タグの活用
- 機能名、担当チーム、ドキュメント種別などをタグとして統一しておくと、横断的な検索が効率的になります
- タグのルールをチーム内で事前に決めておくことで、検索精度が向上します
下書き機能の活用
- 執筆途中のページは下書き状態で保存し、内容が固まってから公開ステータスに変更することで、未完成の情報がチームに共有されるのを防げます