Add glossary_guide.md to standardize glossary.md generation#17
Merged
Conversation
用語集の項目に実装の詳細（クラス名・メソッド名・API・処理手順）が書かれてしまい、実装変更のたびに glossary への追従が必要になる問題に対処。glossary_guide.md を新設し、判定テスト・書くもの/書かないもの・長さの目安を明文化。setup / new-cap / catchup / quick-catchup / propose の glossary.md 更新手順から参照するようにした。 Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_012ZqeVeR6bCYCJ8Ze1BxVkb
glossary_guide.md は判断がシンプル（実装技術を置き換えても定義文は変わらないか、の一問）なので独立ファイルにするほどではないと判断。判定テストと悪い例/良い例を .miko/examples/glossary.md に直接書き、各スキルの glossary.md 更新手順には一文だけ追記した。 Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_012ZqeVeR6bCYCJ8Ze1BxVkb
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a comprehensive generation guide for
glossary.mdto prevent implementation details from being included in the glossary. This addresses the problem where glossary entries become outdated whenever implementation changes occur.Key Changes
New guide document (
ofuda/guides/glossary_guide.md): Establishes clear principles for writing glossary entriesUpdated skill workflows: All miko skills that update
glossary.mdnow reference the new guidemiko.setup,miko.new-cap,miko.catchup,miko.quick-catchup,miko.proposeUpdated documentation:
business_rules_driven_development.md: Added glossary_guide.md to the reference materials tableofuda/examples/glossary.md: Added note that entries contain only definitions, not implementation detailsCLAUDE.md: Added glossary_guide.md to required reading listVersion bump: v1.4.0 → v1.5.0
Implementation Details
The guide establishes a consistent judgment criterion across all miko workflows: glossary entries should capture what a term means in the business domain, not how it is implemented. This ensures glossary.md remains stable even as technical implementation evolves, reducing maintenance burden and AI follow-up errors.
https://claude.ai/code/session_012ZqeVeR6bCYCJ8Ze1BxVkb