Skip to content

docs: README を、何の実例でなぜそう作ったかから語る構成に書き直す - #67

Merged
yktsnet merged 1 commit into
mainfrom
docs/readme-narrative
Sep 29, 2026
Merged

yktsnet merged 1 commit into
mainfrom
docs/readme-narrative

Conversation

@yktsnet

@yktsnet yktsnet commented Sep 29, 2026

Copy link
Copy Markdown
Owner

概要

README が仕組みの箇条書きになっていて、このリポが何の実例で、なぜそう作ったかが読めなかった。portfolio の Step 3(型を標準化し、組織には一部だけ配る)に合わせ、「規則をリポジトリではなく環境に置く」実例として語り直す。sdlc-kit との役割分担も書く。

変更

  • 導入: H1 直下を「規則ごと Nix 構成として公開した開発環境」とし、sdlc-kit との関係を1文で置く
  • From Writing to Checking: 書く仕事から確かめる仕事へ移り、人にもエージェントにも覚えていることを求めなくなった経緯
  • Rules Live in the Environment: 規則の置き場の分け方と、5つの仕組み(道具の統一・遮断・配布・役割の分離・機密)を、無いと何が起きるかとあわせて書く
  • What Ships to sdlc-kit: 切り出す基準(portfolio の3条件)と、端末に紐づくので残るもの
  • What Is Not Here: 公開範囲と、clone して適用することを想定しない理由
  • Repository Map: ディレクトリと各節の対応
  • 外したもの
    • Principles(導入順序)と Development Lifecycle は、導入する人に向けた内容で sdlc-kit の側の主張なので外し、lifecycle はリンクだけ残す
    • Skills の一覧表は .claude/skills/README.md へ移す
  • 英語版も同じ構成にし、context/structure.md の README への参照を直す

検証手順

  • README・README.en・.claude/skills/README.md の相対リンクに切れが無いこと
  • 外した節(Principles 等)を参照している箇所が無いこと

- Principles・Development Lifecycle を外し、書く仕事から確かめる仕事へ移った経緯から始める
- 仕組みを「無いと何が起きるか」とあわせて、規則を環境に置く5つの節にまとめる
- sdlc-kit へ切り出すものと、端末に紐づくので残すものの線引きを書く
- 公開範囲と clone を想定しない理由を What Is Not Here に置き、Repository Map を足す
- Skills の一覧表を .claude/skills/README.md へ移す
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant