installer updates, bmd module added and moved out of src, created a plan for module installation tool for custom modules, minor flow improvements
This commit is contained in:
81
bmd/agents/doc-keeper-sidecar/knowledge/README.md
Normal file
81
bmd/agents/doc-keeper-sidecar/knowledge/README.md
Normal file
@@ -0,0 +1,81 @@
|
||||
# Atlas's Documentation Knowledge Base
|
||||
|
||||
This directory contains domain-specific knowledge about BMAD documentation maintenance.
|
||||
|
||||
## Knowledge Organization
|
||||
|
||||
### Primary Knowledge Sources
|
||||
|
||||
- All `*.md` files in the project
|
||||
- Code examples within documentation
|
||||
- Git history of documentation changes
|
||||
- Link structure across docs
|
||||
|
||||
This knowledge base supplements those with:
|
||||
|
||||
- Documentation maintenance patterns
|
||||
- Common doc-code drift issues
|
||||
- Link validation strategies
|
||||
- Style guide enforcement
|
||||
|
||||
## Suggested Knowledge Files (to be added as needed)
|
||||
|
||||
### `documentation-map.md`
|
||||
|
||||
- Complete map of all documentation
|
||||
- README hierarchy
|
||||
- Guide organization
|
||||
- Cross-reference topology
|
||||
|
||||
### `style-guide.md`
|
||||
|
||||
- BMAD documentation standards
|
||||
- Markdown formatting rules
|
||||
- Terminology glossary
|
||||
- Voice and tone guidelines
|
||||
|
||||
### `example-catalog.md`
|
||||
|
||||
- Inventory of all code examples
|
||||
- Testing status of examples
|
||||
- Examples needing updates
|
||||
- Example patterns that work well
|
||||
|
||||
### `link-topology.md`
|
||||
|
||||
- Internal link structure
|
||||
- External link inventory
|
||||
- Broken link history
|
||||
- Link validation procedures
|
||||
|
||||
### `doc-drift-patterns.md`
|
||||
|
||||
- Where docs fall behind code
|
||||
- Common synchronization issues
|
||||
- Prevention strategies
|
||||
- Quick-fix templates
|
||||
|
||||
### `readme-templates.md`
|
||||
|
||||
- Standard README sections
|
||||
- Module README template
|
||||
- Workflow README template
|
||||
- Feature documentation template
|
||||
|
||||
### `changelog-guide.md`
|
||||
|
||||
- CHANGELOG.md format
|
||||
- Entry writing guidelines
|
||||
- Categorization rules
|
||||
- User-facing language
|
||||
|
||||
## Usage
|
||||
|
||||
As Atlas maintains documentation, this knowledge base should grow with:
|
||||
|
||||
- Patterns in documentation drift
|
||||
- Effective doc update strategies
|
||||
- Link validation findings
|
||||
- Style consistency improvements
|
||||
|
||||
The goal: Build institutional knowledge so documentation stays healthy and accurate as the codebase evolves.
|
||||
Reference in New Issue
Block a user