feat: add domain knowledge documentation to agent-ready plugin#32
Merged
feat: add domain knowledge documentation to agent-ready plugin#32
Conversation
f03ffb4 to
771fb04
Compare
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
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
docs/DOMAIN.mdtemplate to the agent-ready plugin that documents business domain concepts, terminology, and workflowsMotivation
Co-locating domain knowledge in the codebase proved more effective than external wikis (Notion, Confluence) because it's version-controlled, discoverable, and accessible to AI agents.
What changed
assets/domain-knowledge-template.md): Glossary, Core Workflows, Domain Relationships, and optional Regulatory/Compliance Context sections with opinionated template notesdocs/DOMAIN.mdby scanning model/entity/type names; audit mode checks DOMAIN.md coverage; summary highlights it as "the most valuable file for human and AI onboarding"Test plan
/agent-ready scaffoldon a test repo and verifydocs/DOMAIN.mdis created with seeded terms/agent-ready auditon a repo without DOMAIN.md and verify it flags the gap/agent-ready auditon a repo with a stub DOMAIN.md and verify it identifies it as a stub