docs: add restructure proposal for databank and PMO separation
Co-authored-by: Qwen-Coder <qwen-coder@alibabacloud.com>
This commit is contained in:
205
collab/proposals/RESTRUCTURE-PROPOSAL.md
Normal file
205
collab/proposals/RESTRUCTURE-PROPOSAL.md
Normal file
@@ -0,0 +1,205 @@
|
||||
# Date/Time
|
||||
Friday, October 24, 2025 (Timezone: UTC+00:00 - Please adjust to local system time)
|
||||
|
||||
# Change Tracking/Revision Table
|
||||
|
||||
| Date | Version | Description | Author |
|
||||
|------------|---------|--------------------------------------------------|---------------------|
|
||||
| 2025-10-24 | 1.0.0 | Proposal for repository restructuring | AIOS-Public System |
|
||||
|
||||
# Changelog
|
||||
|
||||
| Date | Version | Description |
|
||||
|------------|---------|--------------------------------------------------|
|
||||
| 2025-10-24 | 1.0.0 | Initial creation of restructuring proposal |
|
||||
|
||||
---
|
||||
|
||||
# RESTRUCTURE-PROPOSAL.md: Databank and PMO Separation
|
||||
|
||||
## Overview
|
||||
|
||||
This proposal outlines a restructure of the AI home directory repository to separate the readonly "databank" from the read-write "PMO" components. This provides clear permission boundaries when mounting in containerized development environments.
|
||||
|
||||
## Current Structure vs. Proposed Structure
|
||||
|
||||
### Current Structure
|
||||
```
|
||||
AI-Home-Directory/
|
||||
├── AboutMe.md
|
||||
├── AgentRules.md
|
||||
├── AGENTS.md
|
||||
├── AUDIT1.md
|
||||
├── README.md
|
||||
├── StartHere.md
|
||||
├── TSYS.md
|
||||
├── AI-TOOLS.md
|
||||
├── PROJECT-MGMT-TOOLS.md
|
||||
├── OPS-ENVIRONMENT.md
|
||||
├── collab/ # Collaboration directory
|
||||
│ └── proposals/ # All proposals currently here
|
||||
│ ├── PMO/
|
||||
│ └── ...
|
||||
└── (other files)
|
||||
```
|
||||
|
||||
### Proposed Structure
|
||||
```
|
||||
AI-Home-Directory/ # Mount point in containers
|
||||
├── databank/ # Readonly context (mounted readonly)
|
||||
│ ├── personal/ # Personal information
|
||||
│ │ ├── AboutMe.md
|
||||
│ │ ├── StartHere.md
|
||||
│ │ └── TSYS.md
|
||||
│ ├── agents/ # AI agent guidelines
|
||||
│ │ ├── AgentRules.md
|
||||
│ │ ├── AGENTS.md
|
||||
│ │ └── AI-TOOLS.md
|
||||
│ ├── context/ # General context information
|
||||
│ │ ├── AUDIT1.md
|
||||
│ │ └── PROJECT-MGMT-TOOLS.md
|
||||
│ └── templates/ # Template files for projects
|
||||
│ └── ...
|
||||
├── pmo/ # Read-write PMO (mounted read-write)
|
||||
│ ├── dashboard/ # PMO dashboard views
|
||||
│ │ └── ...
|
||||
│ ├── projects/ # Project registry and links
|
||||
│ │ └── ...
|
||||
│ ├── reports/ # Status reports
|
||||
│ │ └── ...
|
||||
│ ├── resources/ # Resource management
|
||||
│ │ └── ...
|
||||
│ └── config/ # PMO configuration
|
||||
│ └── ...
|
||||
├── collab/ # Collaboration directory (readonly)
|
||||
│ └── ...
|
||||
└── README.md # Updated to reflect new structure
|
||||
```
|
||||
|
||||
## Benefits of Restructure
|
||||
|
||||
### 1. Clear Permission Boundaries
|
||||
| Component | Permission | Purpose |
|
||||
|-----------|------------|---------|
|
||||
| **databank/** | Readonly | Consistent context across projects |
|
||||
| **pmo/** | Read-Write | Project management updates |
|
||||
| **collab/** | Readonly | Collaboration guidelines |
|
||||
|
||||
### 2. Enhanced Security
|
||||
- Prevents accidental modification of core knowledge base
|
||||
- Limits write access to specific PMO functions
|
||||
- Reduces risk of corrupting foundational information
|
||||
|
||||
### 3. Better Organization
|
||||
- Separates static context from dynamic management
|
||||
- Clearer directory structure for new users
|
||||
- Easier navigation and maintenance
|
||||
|
||||
### 4. Improved Container Integration
|
||||
| Mount Point | Access Mode | Purpose |
|
||||
|-------------|-------------|---------|
|
||||
| `/ai-home/databank` | `:ro` (readonly) | Universal context for all tools |
|
||||
| `/ai-home/pmo` | `:rw` (read-write) | PMO updates and tracking |
|
||||
|
||||
## Migration Strategy
|
||||
|
||||
### Phase 1: Directory Creation
|
||||
```bash
|
||||
# Create new directory structure
|
||||
mkdir -p databank/{personal,agents,context,templates}
|
||||
mkdir -p pmo/{dashboard,projects,reports,resources,config}
|
||||
```
|
||||
|
||||
### Phase 2: File Migration
|
||||
| Source File | Destination | Type |
|
||||
|-------------|-------------|------|
|
||||
| AboutMe.md | databank/personal/ | Personal info |
|
||||
| AgentRules.md | databank/agents/ | Agent guidelines |
|
||||
| AGENTS.md | databank/agents/ | Agent guidelines |
|
||||
| AUDIT1.md | databank/context/ | Context information |
|
||||
| AI-TOOLS.md | databank/agents/ | Agent context |
|
||||
| PROJECT-MGMT-TOOLS.md | databank/context/ | Context information |
|
||||
| (new PMO files) | pmo/ | PMO functionality |
|
||||
|
||||
### Phase 3: Update Documentation
|
||||
- Update README.md to reflect new structure
|
||||
- Update AGENTS.md to reference new paths
|
||||
- Create PMO-specific documentation
|
||||
|
||||
### Phase 4: Update Proposals
|
||||
- Move PMO proposals to new pmo/ directory
|
||||
- Create new PMO templates
|
||||
- Update PMO proposal based on new structure
|
||||
|
||||
## Container Usage Pattern
|
||||
|
||||
### Before (Current)
|
||||
```bash
|
||||
# Single mount point with mixed permissions
|
||||
docker run -v /path/to/AI-Home-Directory:/ai-home your-development-image
|
||||
```
|
||||
|
||||
### After (Proposed)
|
||||
```bash
|
||||
# Separate mount points with clear permissions
|
||||
docker run \
|
||||
-v /path/to/AI-Home-Directory/databank:/ai-home/databank:ro \
|
||||
-v /path/to/AI-Home-Directory/pmo:/ai-home/pmo:rw \
|
||||
your-development-image
|
||||
```
|
||||
|
||||
## Impact Analysis
|
||||
|
||||
### Positive Impacts
|
||||
- ✅ Clearer separation of concerns
|
||||
- ✅ Better security through permission boundaries
|
||||
- ✅ Improved organization and navigation
|
||||
- ✅ More secure container mounting
|
||||
- ✅ Better alignment with PMO concept
|
||||
|
||||
### Potential Challenges
|
||||
- ⚠️ Requires updates to all references in documentation
|
||||
- ⚠️ Need to update AI agent configurations
|
||||
- ⚠️ Migration path for existing projects
|
||||
- ⚠️ Updates to mounting procedures
|
||||
|
||||
## Implementation Steps
|
||||
|
||||
### 1. Preparation
|
||||
- [ ] Create new directory structure
|
||||
- [ ] Prepare migration script
|
||||
- [ ] Update documentation templates
|
||||
|
||||
### 2. Migration
|
||||
- [ ] Move files to appropriate directories
|
||||
- [ ] Update internal file references
|
||||
- [ ] Test new structure
|
||||
|
||||
### 3. Validation
|
||||
- [ ] Verify all links work correctly
|
||||
- [ ] Test container mounting patterns
|
||||
- [ ] Validate AI agent access patterns
|
||||
|
||||
### 4. Rollout
|
||||
- [ ] Update README and documentation
|
||||
- [ ] Update AGENTS.md with new paths
|
||||
- [ ] Communicate changes to AI agents
|
||||
|
||||
## AI Agent Considerations
|
||||
|
||||
### Access Patterns
|
||||
- **Databank Access**: Readonly for context and guidelines
|
||||
- **PMO Access**: Read-write for project updates and tracking
|
||||
- **Agent Updates**: Only update PMO when milestones reached
|
||||
|
||||
### Path Updates
|
||||
AI agents will need to be aware of:
|
||||
- `/ai-home/databank/` for readonly context
|
||||
- `/ai-home/pmo/` for PMO updates
|
||||
- New path structure in AGENTS.md
|
||||
|
||||
## Conclusion
|
||||
|
||||
This restructuring provides a cleaner, more secure, and more organized approach to managing your AI home directory. The separation of readonly databank and read-write PMO components aligns perfectly with your usage patterns and provides clear permission boundaries for containerized development environments.
|
||||
|
||||
The proposed structure supports your goal of having a readonly databank that can be safely mounted across all projects while maintaining a separate PMO area where AI agents can make updates without risk to the core knowledge base.
|
||||
Reference in New Issue
Block a user