stxtバージョン管理規定 Ver.1.1

項番を表示

表示形式:

オーガニックツリー

ロジックツリー

アイデアボード

マインドマップ

ピラミッド ※開発中

ドキュメント ※開発中

アウトライン ※開発中

0. **stxtバージョン管理規定 Ver.1.1** 📜

1. (s) **基本方針**
 11. (g) **セマンティックバージョニング採用:** 文書バージョンは `vMAJOR.MINOR` 形式 (例: `v1.0`, `v1.1`, `v2.0`)で管理する。
  111. (i) **メジャー (v2.0):** 構成の大幅な変更、コンセプトの刷新など、後方互換性のない変更。
  112. (i) **マイナー (v1.1):** 項目の追加や内容の拡充など、後方互換性のある変更。
 12. (g) **ファイルによる履歴化:** バージョンアップ時には、旧版のstxtは`status: archived`とし、新バージョンのstxtを新規作成する。
 13. (i) **目的:** LTsite上で、誰でも直感的にバージョン履歴を追えるようにする。

2. (s) **具体的な運用フロー：バージョンアップ時**
 (i) 例：「LTsite開発ロードマップ v1.0」を「v1.1」に更新する場合
 21. (v) **Step1. 既存ファイルを複製:** `...-roadmap-v1.0.stxt` を複製する。
 22. (v) **Step2. 新バージョンとしてリネーム:** 複製したファイルを`...-roadmap-v1.1.stxt`のように、新しいバージョン番号でリネームする。（IDとslugも合わせて修正）
 23. (v) **Step3. 旧版をアーカイブ化:** **元のファイル** (`...-v1.0.stxt`) のメタデータに、以下の1行を追加する。
  `status: archived`
 24. (v) **Step4. 新バージョンを編集:** 新しい`...-v1.1.stxt`の内容を、v1.1の内容に更新する。

3. (s) **ファイル名とslugの命名規約**
 31. (g) **原則:** バージョン管理対象の文書は、slugの末尾にバージョン番号を含める。
 32. (r) **禁止事項:** ファイル名/slugにドット`.`は使用しない。
 33. (g) **推奨形式:** `v[メジャー番号]-[マイナー番号]` の形式で、ハイフン区切りとする。
  331. (v) ✅ **OK:** `ltsite-roadmap-v1-1`
  332. (x) ❌ **NG:** `ltsite-roadmap-v1.1`
 34. (i) **表示名との分離:** ファイル名/slugは安全な形式とし、stxtの`title`では `Ver.1.1`のように読みやすい形式で記述する。

4. (s) **補則：バージョン番号がなかった文書の扱い**
 41. (i) **状況:** バージョン管理を導入する前に作成された文書（例: `roadmap.stxt`）を更新し、`v1.1`や`v2.0`を作成する場合。
 42. (g) **ルール:** 最初の更新時に、元の文書は**「バージョン1.0」**として扱う。
 43. (v) **手順:**
  431. (s) 元のファイル（`roadmap.stxt`）を、**`roadmap-v1-0.stxt`** にリネームする。
  432. (s) `./manager stxt:doctor syntext` を実行し、ファイル名に合わせて`id`, `slug`等のメタデータを自動修正させる。
  433. (s) `roadmap-v1-0.stxt`の`status`を `archived` に変更する。
  434. (s) 新しいバージョン（例: `roadmap-v1-1.stxt`）を、`stxt:create`コマンドで新規作成する。