ドキュメントの作成と編集
AB Projects(エイビープロジェクト) のドキュメントは、完全なバージョン履歴を持つ Markdown ページです。作成と編集はライブプレビュー付きのサイドパネルで行われ、すべての変更が記録されるため、チームは何がなぜ変わったかを常に把握できます。
ページを作成する
- プロジェクトの ドキュメント 領域で新しいページを開始します。タイトル、任意の 親パス(既定は
/—onboardingのように設定するとネストされます)、任意の タグ を付けます。 - 本文を Markdown で書きます。エディターはソースの隣に ライブプレビュー を表示するため、入力しながら描画結果を確認できます。
- 保存するとページがツリーに公開されます。バージョン 1 になります。
ページを編集する
- ページを開き、編集(ページのアクションメニューから)を選びます。現在の Markdown とともに同じパネルが開きます。
- 編集時には編集メモが必須です。 変更を保存する前に、何が変わったかを説明する短いメモを入力する必要があります — 空のままだと AB Projects(エイビープロジェクト) は「チームに何が変わったか分かるように」メモの追加を求めます。(新規ページにメモは不要ですが、編集には必要です。)
- 保存すると上書きではなく 新しいバージョン が作成されます — 以前のバージョンは保存されます。
バージョン履歴と復元
- すべてのページは バージョン番号 と最新の編集者・時刻を追跡します。
- ページのアクションメニューから 履歴 を開くと、各バージョンが編集メモとともに表示されます — すべての変更の「なぜ」が記録に残ります。
- 履歴一覧から以前のバージョンを 復元 できます。復元するとそのコンテンツが現在のページとして戻り(それ自体も新しいバージョンとして記録されます)。
ページを削除する
- 削除 はページのアクションメニューから利用でき、誤ってクリックされないよう編集/履歴とは意図的に離して配置されています。
- 削除するとページがツリーから取り除かれます。慎重な操作として扱ってください — コンテンツを変えたいだけなら削除より編集や復元を優先しましょう。
ヒント
- 親パスを使って明確な構造を作りましょう(例:
engineering/runbooks)。フラットなページ一覧にしないこと。 - 意味のある編集メモを書きましょう — 履歴に表示され、差分を見なくても変更を理解するためにチームメイトが頼りにします。
- 保存前にライブプレビューで書式(見出し、コードブロック、リンク)を確認しましょう。
- 編集を誤ったら、記憶を頼りに書き直すのではなく履歴から以前のバージョンを復元しましょう。
Markdown、ライブプレビュー、必須の編集メモ、復元付きの完全な履歴により、ドキュメントは書きやすく、安全に変更できます。