Kade Heyborne
48c6ddc066
- Complete planning documentation for 5-phase development - UI design specifications and integration - Domain architecture and directory templates - Technical specifications and requirements - Knowledge incorporation strategies - Dana language reference and integration notes
168 lines
5.0 KiB
Markdown
168 lines
5.0 KiB
Markdown
# Directory Structure Templates
|
|
|
|
This document defines the standard directory structure templates for the Advanced Second Brain PKM system. These templates ensure consistency across knowledge domains and provide a framework for organizing information effectively.
|
|
|
|
## Domain Directory Template
|
|
|
|
Each knowledge domain should follow this standardized structure:
|
|
|
|
```
|
|
domain-name/
|
|
├── _meta/
|
|
│ ├── domain-config.json # Domain-specific configuration
|
|
│ ├── agents/ # Domain-specific AI agents
|
|
│ │ ├── researcher.na
|
|
│ │ ├── summarizer.na
|
|
│ │ └── curator.na
|
|
│ └── templates/ # Domain-specific templates
|
|
│ ├── note-template.md
|
|
│ └── project-template.md
|
|
├── archive/ # Archived content
|
|
├── assets/ # Images, documents, media
|
|
├── inbox/ # New content entry point
|
|
├── notes/ # Processed knowledge
|
|
│ ├── concepts/ # Core concepts and definitions
|
|
│ ├── projects/ # Active projects and tasks
|
|
│ ├── research/ # Research materials and findings
|
|
│ └── references/ # External references and citations
|
|
├── projects/ # Project-specific directories
|
|
│ └── project-name/
|
|
│ ├── _meta/
|
|
│ ├── assets/
|
|
│ ├── notes/
|
|
│ └── deliverables/
|
|
└── README.md # Domain overview and navigation
|
|
```
|
|
|
|
## File Naming Conventions
|
|
|
|
### Documents and Notes
|
|
- Use kebab-case for filenames: `knowledge-graph-implementation.md`
|
|
- Include dates for time-sensitive content: `2024-01-15-meeting-notes.md`
|
|
- Use descriptive prefixes for categorization: `concept-neural-networks.md`
|
|
|
|
### Directories
|
|
- Use lowercase with hyphens: `machine-learning-concepts/`
|
|
- Group related items: `research-papers/`, `code-examples/`
|
|
|
|
## Content Organization Principles
|
|
|
|
### _meta/ Directory
|
|
Contains domain configuration and automation:
|
|
- `domain-config.json`: Domain settings, tags, relationships
|
|
- `agents/`: Dana agents specific to this domain
|
|
- `templates/`: Reusable templates for consistent formatting
|
|
|
|
### Content Flow
|
|
1. **Inbox**: Raw content enters here (imports, captures, notes)
|
|
2. **Processing**: Content gets reviewed, tagged, and organized
|
|
3. **Notes**: Processed knowledge with connections and insights
|
|
4. **Archive**: Historical content maintained for reference
|
|
|
|
### Project Structure
|
|
Projects get dedicated subdirectories with full structure:
|
|
- Independent knowledge management
|
|
- Isolated from main domain
|
|
- Can be promoted to separate domains if they grow
|
|
|
|
## Template Files
|
|
|
|
### domain-config.json
|
|
```json
|
|
{
|
|
"name": "Domain Name",
|
|
"description": "Brief description of the domain",
|
|
"tags": ["tag1", "tag2"],
|
|
"relationships": {
|
|
"parent_domains": [],
|
|
"child_domains": [],
|
|
"related_domains": []
|
|
},
|
|
"agents": {
|
|
"default_researcher": "researcher.na",
|
|
"default_summarizer": "summarizer.na"
|
|
},
|
|
"settings": {
|
|
"auto_tag": true,
|
|
"auto_link": true,
|
|
"backup_frequency": "daily"
|
|
}
|
|
}
|
|
```
|
|
|
|
### README.md Template
|
|
```markdown
|
|
# Domain Name
|
|
|
|
Brief description of what this domain contains and its purpose.
|
|
|
|
## Quick Start
|
|
- How to add new content
|
|
- Key concepts and navigation
|
|
- Important agents and automations
|
|
|
|
## Structure
|
|
- `inbox/`: New content entry point
|
|
- `notes/`: Processed knowledge
|
|
- `projects/`: Active work
|
|
- `archive/`: Historical content
|
|
|
|
## Key Topics
|
|
- Topic 1
|
|
- Topic 2
|
|
- Topic 3
|
|
|
|
## Related Domains
|
|
- [Related Domain 1](../related-domain-1/)
|
|
- [Related Domain 2](../related-domain-2/)
|
|
```
|
|
|
|
## Automation Integration
|
|
|
|
### Agent Placement
|
|
- Domain-specific agents in `_meta/agents/`
|
|
- General-purpose agents in global config
|
|
- Project-specific agents override domain defaults
|
|
|
|
### Template System
|
|
- Templates stored in `_meta/templates/`
|
|
- Support for variables and dynamic content
|
|
- Version control for template evolution
|
|
|
|
## Maintenance Guidelines
|
|
|
|
### Regular Tasks
|
|
- Weekly: Review inbox and process new content
|
|
- Monthly: Archive old projects and clean up structure
|
|
- Quarterly: Review and update domain relationships
|
|
|
|
### Quality Checks
|
|
- Ensure consistent naming conventions
|
|
- Verify link integrity
|
|
- Update README files when structure changes
|
|
- Validate agent configurations
|
|
|
|
## Scaling Considerations
|
|
|
|
### Large Domains
|
|
- Split into sub-domains when >1000 files
|
|
- Use index files for navigation
|
|
- Implement automated organization rules
|
|
|
|
### Cross-Domain Links
|
|
- Use relative paths for internal links
|
|
- Maintain relationship metadata
|
|
- Implement global search across domains
|
|
|
|
## Tool Integration
|
|
|
|
### File System Monitoring
|
|
- Watch `_meta/` for configuration changes
|
|
- Trigger reprocessing on structure changes
|
|
- Auto-generate navigation files
|
|
|
|
### Knowledge Graph
|
|
- Map directory structure to graph nodes
|
|
- Create relationships based on file links
|
|
- Generate domain-specific graph views</content>
|
|
<parameter name="filePath">docs/plans/directory-structure-templates.md |