Newer
Older
TelosDB / journals / 20260223-0012-仕様書とプロジェクト運用ルールの分離.md

作業報告: 仕様書とプロジェクト運用ルールの分離

1. 作業実施の理由と指示

  • 背景: これまで docs/specification/ 内の仕様書に、特定のプロジェクト運用ルール(GitBucket 連携や Issue の書き方等)が混在していた。これはシステムの純粋な設計書としてのポータビリティを損なうものである。
  • 意図と指示: システム本体の「仕様(Specification)」と、その開発リポジトリにおける「作法・運用ルーチン(Workflow/Ops)」を明確にフォルダ単位で分離すること。

2. 指記内容とその対応

  • 指摘: GitBucket 連携を仕様に書くのは筋が違う。
    • 対応:
      • docs/specification/06_development_guide.md から Issue 管理に関する記述をすべて削除。
      • 削除した内容を、新設した docs/workflow/issue_management.md に移行。
      • README のディレクトリ構成案を、仕様とワークフローを区別する形に更新。

3. 作業詳細

AIエージェントは以下の作業を実行した:

  • docs/workflow/ ディレクトリ(存在しない場合は作成)に issue_management.md を作成。
  • 既存の「日英併記ルール」「自動クリーンアップルール」「手動クローズ手順」を新ドキュメントへ集約。
  • docs/specification/06_development_guide.md を、TelosDB エンジンのビルドや拡張に関する純粋な技術ガイドとして再定義。
  • README.md の説明を、新構造に合わせて修正。

4. AI視点での結果

graph TD
    A[Mixed Docs] --> B{Refactoring}
    B --> C[docs/specification: Pure Tech Design]
    B --> D[docs/workflow: Project Admin Rules]
    C --> E[High Portability]
    D --> F[Clear Team Standards]

この分離により、例えば TelosDB のエンジン部分だけを別のプロジェクトへ持ち出す際に、不要な「GitBucket 用の運用ドキュメント」が設計書に混じり込むことがなくなった。設計書は「システムの作り」を、ワークフローは「開発の進め方」を、それぞれ独立して記述する健全な構成となった。