Skip to content

Latest commit

 

History

History
114 lines (90 loc) · 6.82 KB

README.md

File metadata and controls

114 lines (90 loc) · 6.82 KB

Documentation Index / 文書索引

Summary: The index of all documents in this repository: policies (our position), specifications (rules to implement), decisions (why we chose), demos (records of what was actually done), status (milestone progress), hand-offs (requests to other teams), reviews (review records), and reference (external facts). A Mermaid diagram shows how a change flows through the process. 概要: このリポジトリのすべての文書の索引。方針(私たちの立場)、仕様(実装するルール)、決定(なぜ選んだか)、実証(実際にやったことの記録)、進捗(節目の進行状況)、引継ぎ(他のチームへの依頼)、レビュー(レビュー記録)、参考(外部事実)。Mermaid 図は、変更がプロセスを通る流れを示します。

Jump: English · 日本語

  • Version / 版: 0.2 — 2026-11-06. Learned: a glossary term is only explained for the reader when its note and REF-01 link sit at the first prose use, counting lower-case and plural forms, so first-use notes with links were added in both halves (SPEC-06 §3). / 用語注と REF-01 へのリンクは、小文字や複数形も含めた本文の初出に置かなければ読者に届かないと分かったため、英和両方の初出にリンク付きの用語注を補った(SPEC-06 §3)。
  • Version / 版: 0.1 — 2026-11-05. Learned: without a single index page, it was unclear which folder to check for the latest milestone status or review records; putting everything in one place makes the documentation tree navigable. / 単一の索引ページが無ければ、最新の節目進捗やレビュー記録をどのフォルダで探すべきか分からず、文書ツリーのナビゲートが不可能になると分かった。
  • Normative for: every document under docs/, especially README.md files.
  • Related: ../README.md · site/index.html

English

→ 日本語版へ

1. Document folders

Folder Description
policy/ Our position on what we will and will not do. Each document states our stance on a topic.
spec/ Rules to implement: specifications, acceptance tests, security gate, installer CLI.
decisions/ Decision records: why we chose one way and not another.
demo/ Records of what was actually done: acceptance runs, integration test results.
status/ Milestone progress: M1–M5 status, open items, upstream tracking reports.
handoff/ Requests to other teams: dated files, named YYYY-MM-DD_<Title>.md.
reviews/ Review records: dated files, named YYYY-MM-DD_<Title>_rN.md.
reference/ External facts: glossary, tool versions, upstream metadata.

2. How a change flows

flowchart TD
    A[Demo / Acceptance run] --> B{Pass?}
    B -- yes --> C[Policy: position on the change]
    B -- no --> D[Policy: rejection reason]
    C --> E[Spec / ADR: rules to implement the change]
    D --> E
    E --> F[Code: implement the spec / decision]
    F --> G[Demos: acceptance run with new behavior]
    G --> H[Status: update milestone progress]
    H --> I[Hand-off: request review / merge if ready]
    I --> J[Reviews: independent assessment recorded]
    J --> K{Decision}
    K -- accept --> L[Merge to develop]
    K -- reject --> M[Return for fix]
Loading

3. Links


日本語

→ To English

1. 文書フォルダ

フォルダ 説明
policy/ 我々が何をし、何をしないかの立場。各文書はトピックに関する私たちの姿勢を述べます。
spec/ 実装するルール:仕様、受入試験、セキュリティの門、インストーラー CLI。
decisions/ 決定の記録:なぜその道を選び、ほかを選ばなかったか。
demo/ 実際にやったことの記録:受入試験、統合試験結果。
status/ 節目の進行状況:M1〜M5 の進捗、未解決項目、上流追従報告。
handoff/ 他のチームへの依頼:日付付きファイル、YYYY-MM-DD_<Title>.md の形式。
reviews/ レビュー記録:日付付きファイル、YYYY-MM-DD_<Title>_rN の形式。
reference/ 外部事実:用語集、道具の版、上流メタデータ。

2. 変更が流れる流れ

flowchart TD
    A[実証/受入試験] --> B{合格?}
    B -- はい --> C[方針:変更に関する立場]
    B -- いいえ --> D[方針:拒否理由]
    C --> E[仕様/ADR:変更を実装するルール]
    D --> E
    E --> F[コード:spec/ADR を実装]
    F --> G[実証:新しい動作での受入試験]
    G --> H[進捗:節目の進行状況を更新]
    H --> I[引継ぎ:レビュー/マージの依頼]
    I --> J[レビュー:独立した評価を記録]
    J --> K{決定}
    K -- 承認 --> L[develop へマージ]
    K -- 拒否 --> M[修正のために戻す]
Loading

3. リンク

  • ../README.md — リポジトリ全体のルート索引。
  • site/index.html — MkDocs(Markdown のファイルを Web サイトに変える道具。REF-01)が生成する HTML サイト。

Glossary / 用語

Term English note 日本語注
Policy A statement of our position on what we will and will not do. 我々が何をし、何をしないかの立場。
Specification A rule book that implementers must follow. 実装する人が守るルールブック。
Decision record (ADR) A note explaining why we chose one way and not another. なぜその道を選び、ほかを選ばなかったかのメモ。
Demo Records of what was actually done, including acceptance runs. 実際にやったことの記録、受入試験を含む。
Milestone A checkpoint with a pass/fail test. 合否の試験がある関門。
Hand-off A request to another team or agent. 他のチーム・エージェントへの依頼。
Review An independent assessment of a pull request. プルリクエストの独立した評価。
Reference External facts such as glossaries, tool versions. 用語集や道具の版などの外部事実。