Skip to content

docs: README.mdのディレクトリ構成とarchitecture.mdを今の状態に合わせる(#76) - #85

Merged
knk1313 merged 1 commit into
mainfrom
docs/76-readme-roadmap
Nov 3, 2026
Merged

knk1313 merged 1 commit into
mainfrom
docs/76-readme-roadmap

Conversation

@knk1313

@knk1313 knk1313 commented Nov 3, 2026

Copy link
Copy Markdown
Owner

🙋 誰が出すか(Author)

  • 書いた人:AIエージェント(管理者の依頼で書いた)
  • AIが書いた場合のモデルとハーネス:Claude Opus 5.5、Claude Code 2.1.312
  • 依頼した人の指示:
  • diffを確認した人:

✍️ 人が書く要約(Human-authored summary)

👏 解決する issue / Resolved Issues

📝 関連する issue / Related Issues

⛏ 変更内容 / Details of Changes

README.mdとdocs/architecture.mdを、v0.5.0以降の状態に合わせた。

README.md

  • ディレクトリ構成に、tests/corpus/(採点の検出率と誤検出を測るコーパス)を足した
  • 「目指す構成」にdocs-rules-feedback/を足し、tests/の説明を今のテストに合わせた
  • Issueで挙げたロードマップの「Step 4の完成の条件」は、依頼した人の判断で書かないことにした

docs/architecture.md

  • 書き直しの流れに、「2回続けて取り消したら前の版で止める」を足した。SKILL.mdには書いてあり、図にだけなかった
  • 最後に、改善点の候補を報告に書き、docs-rules-feedbackがあれば保存する段を足した
  • 図の下に、score.mjsがまとめて動かす判定と、tests/corpus/で検出率と誤検出を測っていることを書いた
  • 「3. 改善点の候補をIssueにする」の節と図を足した(#63で入った流れ)

図のほかの部分(インストールの3経路、文書を書く流れの1〜4)は、SKILL.mdと食い違いがなかった。

🔎 既存のPR / Existing PRs

  • openとclosedの両方で、同じ問題を扱うPRを探した
  • 関連するPR:なし

🔍 確認したこと / Verification

  • 変更した日本語をskills/docs-rules/rules/のルールに照らして点検した(node --test tests/*.test.mjsの採点のテストを含め、64件が通った)
  • ファイルやディレクトリを増減した場合、README.mdのディレクトリ構成を更新した(このPRで更新した)
  • .claude-plugin/やスキルの置き場所を変えた場合、CONTRIBUTING.mdの「プラグイン配布の検証」を通した(置き場所の変更はない)
  • python3 tests/test_skill_size.pyを通した
  • 関係のない変更を混ぜていない

🤖 Generated with Claude Code

- README.mdのディレクトリ構成にtests/corpus/を、目指す構成にdocs-rules-feedback/を足した
- architecture.mdに、取り消しで止める条件、改善点の候補を保存する段、改善点をIssueにする流れを足した

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@knk1313
knk1313 merged commit d623fb9 into main Nov 3, 2026
2 checks passed
@github-actions

github-actions Bot commented Nov 3, 2026

Copy link
Copy Markdown

Thank you for your contribution! 🎉

Spinning cat

@knk1313
knk1313 deleted the docs/76-readme-roadmap branch November 3, 2026 07:44
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.

docs: README.mdのディレクトリ構成とロードマップ、architecture.mdをv0.5.0に合わせる

1 participant