Skip to content

プロジェクトドキュメント整備(docs/ ディレクトリ) #46

Description

@ktmage

Description

プロジェクト全体のドキュメントが不足しているため、リポジトリ内に docs/ ディレクトリを設け、体系的にドキュメントを整備する。

現在、外部仕様書・内部仕様書は .ktmage/project/ 配下に非公開で管理されているが、これらを docs/ に統合して公開する。既存ファイルの単純移行ではなく、各機能を改めて確認した上で新規作成する。

対象ドキュメントと docs/ 構成

docs/
  README.md                           # ドキュメント索引
  architecture/
    overview.md                       # 全体アーキテクチャ(軽めに。今後大きく変わる前提)
  design/
    component-guide.md                # Atomic Design 方針・コンポーネント責務
  testing/
    strategy.md                       # テスト戦略・テストの書き方・命名規則
  operations/
    release.md                        # リリース手順
  specs/
    external/                         # 外部仕様書(機能要件)— 新規作成
      index.md
    internal/                         # 内部仕様書(技術設計)— 新規作成
      index.md

タスク一覧

# タスク 概要
1 docs/ ディレクトリ作成・索引整備 docs/README.md でドキュメント全体の索引を作成
2 アーキテクチャ概要の新規作成 Extension Host / Webview の2層構成、責務分担を軽く記述。今後大きく変わる前提で簡潔に
3 コンポーネント設計ガイドの新規作成 Atomic Design の方針と各層(atoms/molecules/organisms)の責務を記述
4 テスト戦略ガイドの新規作成 テスト種別(シナリオ/コンポーネント/フック/ユーティリティ)の使い分け、命名規則、書き方の指針
5 リリース手順の移行 .ktmage/project/release-procedure.mddocs/operations/release.md に移行
6 外部仕様書の新規作成 各機能を改めて確認し、docs/specs/external/ に新規作成(既存の .ktmage/project/external-spec/ からの単純移行ではない)
7 内部仕様書の新規作成 各機能を改めて確認し、docs/specs/internal/ に新規作成(既存の .ktmage/project/internal-spec/ からの単純移行ではない)
8 .ktmage/ のスキル・設定更新 仕様書の参照先パスを docs/specs/ に変更(config.yml, manage-external-spec, manage-internal-spec)
9 README.md のドキュメントセクション更新 docs/ へのリンクを追加

注意事項

  • ドキュメントの言語は日本語
  • アーキテクチャ概要は今後大きく変更される可能性があるため、軽めの記述に留める
  • 外部仕様書・内部仕様書は既存ファイルの移行ではなく、機能を改めて確認した上で新規作成する
  • .ktmage/project/ 内のタスク定義書・議事録など Issue 単位の作業記録はそのまま残す

Motivation

  • プロジェクトの設計思想やテスト方針がコードを読まないとわからない状態になっている
  • 外部仕様書・内部仕様書が .ktmage/project/ に非公開で置かれており、コントリビューターからは見えない
  • アーキテクチャ、コンポーネント設計、テスト戦略、リリース手順など、開発に必要な情報が散在している
  • 体系的なドキュメントを整備することで、メンテナー自身の参照用としても、コントリビューターのオンボーディングとしても機能させたい

Proposed Solution

リポジトリルートに docs/ ディレクトリを作成し、上記の構成でドキュメントを整備する。タスク一覧の順序で段階的に作成していく。

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions