From 347ef9d49602fe34038046d5c83b62b75b97535d Mon Sep 17 00:00:00 2001 From: ReachableCEO Date: Fri, 24 Oct 2025 10:43:51 -0500 Subject: [PATCH] docs: update repository structure, add COO directories, and merge v2 proposal updates\n\n- Update main README.md repository structure to reflect current state\n- Remove context/ directory from databank as per new structure\n- Add COO sections to both databank/ and pmo/ directories\n- Create COO directories for transition to Albert\n- Add GLOSSARY.md template for project use\n- Update AGENTS.md to include COO transition information for Albert\n- Add rule requiring acronyms to be defined when first used\n- Add GLOSSARY requirement for all projects\n- Update PMO section to explain PMO (Project Management Office) acronym\n- Merge updates from PROPOSAL-AGENTS-v2.md into current AGENTS.md\n- Update version tracking in AGENTS.md to v8.0.0 reflecting COO changes\n- Add change tracking table to README.md\n- Reflect that project management artifacts stay local to projects with PMO linking to them\n- Update authority structure to include Albert's future role in COO transition Co-authored-by: Qwen-Coder --- README.md | 56 ++++---- databank/agents/AGENTS.md | 40 ++++-- databank/templates/GLOSSARY.md | 36 +++++ pmo/artifacts/dashboard/DASHBOARD_TEMPLATE.md | 74 +++++++++++ pmo/artifacts/dashboard/README.md | 35 +++++ pmo/artifacts/dashboard/current-dashboard.md | 71 ++++++++++ pmo/artifacts/docs/add-project-guide.md | 123 ++++++++++++++++++ pmo/artifacts/docs/index.md | 1 + pmo/artifacts/projects/PROJECT_TEMPLATE.md | 49 +++++++ pmo/artifacts/projects/README.md | 48 +++++++ .../projects/SAMPLE-001_DemoProject.json | 72 ++++++++++ .../projects/SAMPLE-001_DemoProject.md | 53 ++++++++ pmo/artifacts/projects/project-template.json | 45 +++++++ 13 files changed, 669 insertions(+), 34 deletions(-) create mode 100644 databank/templates/GLOSSARY.md create mode 100644 pmo/artifacts/dashboard/DASHBOARD_TEMPLATE.md create mode 100644 pmo/artifacts/dashboard/README.md create mode 100644 pmo/artifacts/dashboard/current-dashboard.md create mode 100644 pmo/artifacts/docs/add-project-guide.md create mode 100644 pmo/artifacts/projects/PROJECT_TEMPLATE.md create mode 100644 pmo/artifacts/projects/README.md create mode 100644 pmo/artifacts/projects/SAMPLE-001_DemoProject.json create mode 100644 pmo/artifacts/projects/SAMPLE-001_DemoProject.md create mode 100644 pmo/artifacts/projects/project-template.json diff --git a/README.md b/README.md index 10ae5f9..66f5fbf 100644 --- a/README.md +++ b/README.md @@ -34,24 +34,33 @@ 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 -│ ├── context/ # General context information -│ │ ├── AUDIT1.md -│ │ └── PROJECT-MGMT-TOOLS.md │ ├── operations/ # Operational environment information │ │ └── OPERATIONS-KNOWLEDGE-TRANSFER.md -│ └── templates/ # Template files for projects -│ └── OPS-ENVIRONMENT.md +│ ├── coo/ # Chief Operating Officer domain +│ │ └── (COO handoff information and processes) +│ ├── templates/ # Template files for projects +│ │ └── OPS-ENVIRONMENT.md +│ ├── collab/ # Human/AI interaction space +│ └── artifacts/ # AI-managed content and resources +│ ├── docs/ # AI-managed documentation +│ ├── code/ # AI-managed code artifacts +│ ├── config/ # AI-managed configuration +│ └── templates/ # AI-managed templates ├── pmo/ # ✏️ Read-write PMO (mounted read-write) -│ ├── dashboard/ # PMO dashboard views +│ ├── artifacts/ # PMO components and data +│ │ ├── dashboard/ # PMO dashboard views +│ │ ├── projects/ # Project registry and tracking links +│ │ ├── reports/ # Status reports +│ │ ├── resources/ # Resource management +│ │ ├── config/ # PMO configuration +│ │ └── docs/ # PMO documentation +│ ├── coo/ # COO-specific project management +│ └── collab/ # PMO-specific collaboration │ ├── projects/ # Project registry and links │ ├── reports/ # Status reports │ ├── resources/ # Resource management @@ -126,22 +135,16 @@ The databank directory contains readonly information that provides consistent co | [**AGENTS.md**](./databank/agents/AGENTS.md) | Guidelines for AI agents working with this repo | | [**AI-TOOLS.md**](./databank/agents/AI-TOOLS.md) | AI tool preferences and usage patterns | -### Context Information (`databank/context/`) -| File | Purpose | -|------|---------| -| [**AUDIT1.md**](./databank/context/AUDIT1.md) | Analysis and improvement suggestions (template/example) | -| [**PROJECT-MGMT-TOOLS.md**](./databank/context/PROJECT-MGMT-TOOLS.md) | CLI project management tool recommendations | - -### Templates (`databank/templates/`) -| File | Purpose | -|------|---------| -| [**OPS-ENVIRONMENT.md**](./databank/templates/OPS-ENVIRONMENT.md) | Operational environment template | - ### Operations (`databank/operations/`) | File | Purpose | |------|---------| | [**OPERATIONS-KNOWLEDGE-TRANSFER.md**](./databank/operations/OPERATIONS-KNOWLEDGE-TRANSFER.md) | Knowledge transfer interview for operational roles | +### COO (`databank/coo/`) +| Directory | Purpose | +|-----------|---------| +| [**databank/coo/**](./databank/coo/) | Chief Operating Officer domain and handoff information | + ### Templates (`databank/templates/`) | File | Purpose | |------|---------| @@ -166,7 +169,7 @@ The databank directory contains readonly information that provides consistent co ## 📊 PMO (Read-Write) -The PMO directory contains project management functionality where AI agents can update project status and milestones. +The PMO (Project Management Office) directory contains project management functionality where AI agents can update project status and milestones. Project management/todo artifacts stay local to their project, and the PMO links to them. Projects will update the PMO using a defined structure/format/protocol. ### PMO Components | Directory | Purpose | @@ -178,6 +181,7 @@ The PMO directory contains project management functionality where AI agents can | **[pmo/artifacts/resources/](./pmo/artifacts/resources/)** | Resource allocation and management | | **[pmo/artifacts/config/](./pmo/artifacts/config/)** | PMO configuration and settings | | **[pmo/artifacts/docs/](./pmo/artifacts/docs/)** | Detailed PMO documentation | +| **[pmo/coo/](./pmo/coo/)** | COO-specific project management | | **[pmo/collab/](./pmo/collab/)** | PMO-specific collaboration | ### PMO Update Guidelines @@ -267,5 +271,13 @@ Since this serves as a living knowledge base: --- +## Change Tracking/Revision Table + +| Date/Time | Version | Description | Author | +|----------------------------------|---------|--------------------------------------------------|---------------------| +| 2025-10-24 10:34 CDT (UTC-05:00) | 1.0.0 | Initial change tracking table for README | Charles N Wyble (@ReachableCEO) | + +--- + *Last updated: October 24, 2025* *Part of the AIOS (AI Operating System) ecosystem* \ No newline at end of file diff --git a/databank/agents/AGENTS.md b/databank/agents/AGENTS.md index 78e58e5..299115b 100644 --- a/databank/agents/AGENTS.md +++ b/databank/agents/AGENTS.md @@ -1,5 +1,5 @@ # Date/Time -Friday October 24, 2025 09:43 CDT (UTC-05:00) +Friday October 24, 2025 10:34 CDT (UTC-05:00) --- @@ -24,21 +24,31 @@ Friday October 24, 2025 09:43 CDT (UTC-05:00) - **Date/Time Headers**: Include full date/time with timezone in all markdown files (date, time, timezone format) - **Change Tracking**: Maintain revision tables in all documents with full date/time/timezone (single table format) - **Changelog Elimination**: Remove separate changelog sections - use only Change Tracking/Revision Table format +- **Directory Structure**: Remove separate context/ directory - use subject-specific top-level directories instead (e.g., coo/, operations/, etc.) +- **Acronym Definition**: All acronyms must be defined when first used (e.g., PMO (Project Management Office)) - **Make It Beautiful Rule**: All documentation follows beautiful formatting standards (tables, bullet points, clear structure, visual hierarchy) +- **GLOSSARY Requirement**: All projects must include a GLOSSARY.md file explaining domain terms ## Repository Management ### Structure Requirements -- **Databank**: Readonly context (do not modify) +- **Databank**: Readonly context (do not modify except in designated areas) - `databank/personal/` - Personal information - `databank/agents/` - Agent guidelines and tools - - `databank/context/` - General context information + - `databank/operations/` - Operational environment information + - `databank/coo/` - Chief Operating Officer domain (for Albert and his AI agents) + - `databank/templates/` - Template files for projects + - `databank/collab/` - Human/AI interaction space (read/write for interaction) + - `databank/artifacts/` - AI-managed content (fully managed by AI) - **PMO**: Read-write project management (updates allowed here) - - `pmo/dashboard/` - Dashboard views - - `pmo/projects/` - Project registry and tracking - - `pmo/reports/` - Status reports - - `pmo/resources/` - Resource management - - `pmo/config/` - Configuration + - `pmo/artifacts/dashboard/` - Dashboard views + - `pmo/artifacts/projects/` - Project registry and tracking + - `pmo/artifacts/reports/` - Status reports + - `pmo/artifacts/resources/` - Resource management + - `pmo/artifacts/config/` - Configuration + - `pmo/artifacts/docs/` - Documentation + - `pmo/coo/` - COO-specific project management + - `pmo/collab/` - PMO-specific collaboration - Keep top-level repository clean (databank, pmo, and collab directories only) - Use conventional commits (chore:, feat:, docs:, fix:, etc.) - Commit frequently using atomic commits @@ -71,6 +81,9 @@ Friday October 24, 2025 09:43 CDT (UTC-05:00) ## PMO Update Guidelines +### PMO Overview +The PMO (Project Management Office) provides centralized project oversight. Project management/todo artifacts stay local to their project, and the PMO links to them using a defined structure/format/protocol. + ### When to Update PMO - When project milestones are reached - When project status changes significantly @@ -84,6 +97,7 @@ Friday October 24, 2025 09:43 CDT (UTC-05:00) - Status reports in `pmo/artifacts/reports/` - Resource tracking in `pmo/artifacts/resources/` - Configuration in `pmo/artifacts/config/` +- COO-specific management in `pmo/coo/` (for Albert's operational domain) ### What NOT to Update - **Never modify databank files** - they are readonly @@ -196,13 +210,14 @@ Friday October 24, 2025 09:43 CDT (UTC-05:00) - Follow consistent naming conventions across artifacts ### Authority and Decision Making -- Charles N Wyble (@ReachableCEO) is in charge at all times +- Charles N Wyble (@ReachableCEO) is in charge at all times for general operations +- Albert will become a major user/contributor for COO functions, transitioning from Charles's role as Chief Operating Officer (focused on Vice President Production Technology Operations) by end of December 2025 - If something is adrift between docs and filesystem/code, stop and ask Charles to resolve the issue - Especially if discrepancy isn't reflected in git or conversation history, ask for clarification -- When Charles modifies filesystem manually (vs having AI do it), Charles will ensure AI integrates the changes into mental model -- Do not create or modify things that Charles hasn't explicitly instructed +- When Charles or Albert modify filesystem manually (vs having AI do it), they will ensure AI integrates the changes into mental model +- Do not create or modify things that Charles or Albert haven't explicitly instructed - The filesystem is the source of truth -- If you notice discrepancies between documentation and actual filesystem, ask Charles to resolve +- If you notice discrepancies between documentation and actual filesystem, ask Charles or Albert to resolve ### Tool Integration - Work with existing development tools and workflows @@ -222,6 +237,7 @@ Friday October 24, 2025 09:43 CDT (UTC-05:00) | Date/Time | Version | Description | Author | |----------------------------------|---------|--------------------------------------------------|---------------------| +| 2025-10-24 10:34 CDT (UTC-05:00) | 8.0.0 | Update for COO transition and PMO structure updates | Charles N Wyble (@ReachableCEO) | | 2025-10-24 09:43 CDT (UTC-05:00) | 7.0.2 | Remove changelog, standardize to change tracking table only | Charles N Wyble (@ReachableCEO) | | 2025-10-24 09:43 CDT (UTC-05:00) | 7.0.1 | Update date format to 24-hour no seconds | Charles N Wyble (@ReachableCEO) | | 2025-10-24 09:43 CDT (UTC-05:00) | 7.0.0 | Add full date/time/timezone format guidance | Charles N Wyble (@ReachableCEO) | diff --git a/databank/templates/GLOSSARY.md b/databank/templates/GLOSSARY.md new file mode 100644 index 0000000..ff15d18 --- /dev/null +++ b/databank/templates/GLOSSARY.md @@ -0,0 +1,36 @@ +# Date/Time +Friday October 24, 2025 10:34 CDT (UTC-05:00) + +# Change Tracking/Revision Table + +| Date/Time | Version | Description | Author | +|----------------------------------|---------|--------------------------------------------------|---------------------| +| 2025-10-24 10:34 CDT (UTC-05:00) | 1.0.0 | Initial glossary template | Charles N Wyble (@ReachableCEO) | + +--- + +# Glossary + +This document defines key terms and acronyms used in this project. + +## Acronyms + +| Acronym | Definition | +|---------|------------| +| AI | Artificial Intelligence | +| PMO | Project Management Office | +| COO | Chief Operating Officer | +| CTO | Chief Technology Officer | +| CEO | Chief Executive Officer | +| CI/CD | Continuous Integration/Continuous Deployment | +| AGENTS | AI Guidelines and Execution Templates System | + +## Terms + +| Term | Definition | +|------|------------| +| Databank | Readonly context space mounted in containers | +| PMO | Project Management Office functionality for tracking projects | +| COO Domain | Chief Operating Officer operational space | + +--- \ No newline at end of file diff --git a/pmo/artifacts/dashboard/DASHBOARD_TEMPLATE.md b/pmo/artifacts/dashboard/DASHBOARD_TEMPLATE.md new file mode 100644 index 0000000..c345d0d --- /dev/null +++ b/pmo/artifacts/dashboard/DASHBOARD_TEMPLATE.md @@ -0,0 +1,74 @@ +# PMO Dashboard + +**Last Updated:** YYYY-MM-DD HH:MM:SS + +## Project Overview + +| Project ID | Project Name | Status | Priority | Health | Progress | Next Milestone | Due Date | Tracking | +|------------|--------------|--------|----------|--------|----------|----------------|----------|----------| +| SAMPLE-001 | Demo Project | Active | Medium | Green | 25% | Complete initial design phase | 2025-12-31 | [Link](https://github.com/example/demo-project) | +| [PROJECT_ID] | [Project Name] | [Status] | [Priority] | [Health] | [%] | [Next Milestone] | [Due Date] | [Link] | + +## Portfolio Health + +### Status Distribution +- Active: 1 +- On Hold: 0 +- Completed: 0 +- Planned: 0 + +### Priority Distribution +- Critical: 0 +- High: 0 +- Medium: 1 +- Low: 0 + +### Health Indicators +- Green (Healthy): 1 +- Yellow (Caution): 0 +- Red (At Risk): 0 + +## Priority Queue + +### What to Work On Next +1. **[PROJECT_ID]** - [Next Milestone] (Due: [Date]) +2. **SAMPLE-001** - Complete initial design phase (Due: 2025-11-15) + +## Recent Activity + +| Date | Project | Activity | +|------|---------|----------| +| 2025-10-24 | SAMPLE-001 | Created demo project entry | +| [Date] | [Project] | [Activity] | + +## Resource Allocation + +### Projects by Priority +- **Critical Priority:** None +- **High Priority:** None +- **Medium Priority:** SAMPLE-001 (Demo Project) +- **Low Priority:** None + +### Timeline View +``` + Oct 2025 Nov 2025 Dec 2025 +S M T W T F S S M T W T F S S M T W T F S S M T W T F S S M T W T F S + 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 +SAMPLE-001 ████████████████████████>---------------------------> +``` +Legend: █ = Active work, > = Milestone, - = Planned work + +## Summary Statistics + +- **Total Projects:** 1 +- **Active Projects:** 1 +- **Average Progress:** 25% +- **Projects at Risk:** 0 +- **Upcoming Milestones (30 days):** 1 + +## Quick Actions + +- [Add New Project](../projects/) +- [Update Project Status](../projects/) +- [View All Reports](../reports/) +- [Resource Management](../resources/) \ No newline at end of file diff --git a/pmo/artifacts/dashboard/README.md b/pmo/artifacts/dashboard/README.md new file mode 100644 index 0000000..21ca440 --- /dev/null +++ b/pmo/artifacts/dashboard/README.md @@ -0,0 +1,35 @@ +# PMO Dashboard + +The dashboard provides a high-level view of all projects and their current status. It serves as the central "heads up display" for project management. + +## Dashboard Components + +- **Project Overview Table**: At-a-glance status of all projects +- **Portfolio Health**: Distribution of projects across statuses, priorities, and health indicators +- **Priority Queue**: Ranked list of what to work on next +- **Recent Activity**: Timeline of recent project updates +- **Resource Allocation**: View of resource distribution across projects +- **Timeline View**: Visual representation of project timelines +- **Summary Statistics**: Key metrics about the project portfolio + +## Maintenance + +- Update the dashboard regularly when project statuses change +- AI agents should update dashboard metrics when appropriate +- The dashboard provides an executive summary of portfolio health +- Ensure the "Last Updated" timestamp reflects the most recent change + +## Updating the Dashboard + +The dashboard should be updated when: +- A new project is added to the registry +- Project status, priority, or health changes +- Progress updates occur +- New milestones are reached +- Dependencies change + +## File Structure + +- `DASHBOARD_TEMPLATE.md` - Template for creating dashboards +- `current-dashboard.md` - Current dashboard (if maintained separately) +- Other dashboard views as needed \ No newline at end of file diff --git a/pmo/artifacts/dashboard/current-dashboard.md b/pmo/artifacts/dashboard/current-dashboard.md new file mode 100644 index 0000000..d6a37f4 --- /dev/null +++ b/pmo/artifacts/dashboard/current-dashboard.md @@ -0,0 +1,71 @@ +# Current PMO Dashboard + +**Last Updated:** 2025-10-24 10:30:00 + +## Project Overview + +| Project ID | Project Name | Status | Priority | Health | Progress | Next Milestone | Due Date | Tracking | +|------------|--------------|--------|----------|--------|----------|----------------|----------|----------| +| SAMPLE-001 | Demo Project | Active | Medium | Green | 25% | Complete initial design phase | 2025-11-15 | [Link](https://github.com/example/demo-project) | + +## Portfolio Health + +### Status Distribution +- Active: 1 +- On Hold: 0 +- Completed: 0 +- Planned: 0 + +### Priority Distribution +- Critical: 0 +- High: 0 +- Medium: 1 +- Low: 0 + +### Health Indicators +- Green (Healthy): 1 +- Yellow (Caution): 0 +- Red (At Risk): 0 + +## Priority Queue + +### What to Work On Next +1. **SAMPLE-001** - Complete initial design phase (Due: 2025-11-15) + +## Recent Activity + +| Date | Project | Activity | +|------|---------|----------| +| 2025-10-24 | SAMPLE-001 | Created demo project entry | + +## Resource Allocation + +### Projects by Priority +- **Critical Priority:** None +- **High Priority:** None +- **Medium Priority:** SAMPLE-001 (Demo Project) +- **Low Priority:** None + +### Timeline View +``` + Oct 2025 Nov 2025 Dec 2025 +S M T W T F S S M T W T F S S M T W T F S S M T W T F S S M T W T F S + 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 +SAMPLE-001 ████████████████████████>---------------------------> +``` +Legend: █ = Active work, > = Milestone, - = Planned work + +## Summary Statistics + +- **Total Projects:** 1 +- **Active Projects:** 1 +- **Average Progress:** 25% +- **Projects at Risk:** 0 +- **Upcoming Milestones (30 days):** 1 + +## Quick Actions + +- [Add New Project](../projects/) +- [Update Project Status](../projects/) +- [View All Reports](../reports/) +- [Resource Management](../resources/) \ No newline at end of file diff --git a/pmo/artifacts/docs/add-project-guide.md b/pmo/artifacts/docs/add-project-guide.md new file mode 100644 index 0000000..e764b7e --- /dev/null +++ b/pmo/artifacts/docs/add-project-guide.md @@ -0,0 +1,123 @@ +# Adding Projects to the PMO + +This guide explains how to add new projects to the Project Management Office (PMO) system. + +## Overview + +The PMO system provides centralized visibility into all projects, enabling effective management and coordination. Adding a project to the PMO involves creating a project registry entry and updating the dashboard. + +## Prerequisites + +Before adding a project to the PMO, ensure you have: + +1. A clear project name and unique identifier +2. An understanding of the project scope and objectives +3. A project-specific tracking system set up (GitHub repo, Trello board, etc.) +4. An estimate of the project timeline and milestones + +## Step-by-Step Process + +### Step 1: Prepare Project Information + +Gather the following information for your project: + +- **Name**: Human-readable project name +- **ID**: Unique identifier (e.g., PROJ-001, FEAT-002) +- **Status**: Active, On Hold, Completed, or Planned +- **Priority**: Critical, High, Medium, or Low +- **Health**: Green (Healthy), Yellow (Caution), or Red (At Risk) +- **Tracking URL**: Link to your project-specific tracking system +- **Owner**: Project owner (for future multi-person projects) +- **Dependencies**: Other projects this project depends on (if any) +- **Due Date**: Key milestone or completion date +- **Progress**: Current completion percentage (0-100%) +- **Next Milestone**: The next major milestone to achieve + +### Step 2: Create Project Entry + +1. Navigate to the `pmo/artifacts/projects/` directory +2. Choose your preferred format: + - For human-readable format: Use the `.md` template + - For AI processing: Use the `.json` template +3. Copy the appropriate template file: + - `PROJECT_TEMPLATE.md` for Markdown format + - `project-template.json` for JSON format +4. Rename the file using the convention: `{PROJECT_ID}_{PROJECT_NAME}.{md|json}` + - Example: `PROJ-001_EcommercePlatform.md` +5. Fill in all the project details gathered in Step 1 + +### Step 3: Complete Project Details + +Fill out all sections of the project entry: + +- **Description**: Provide a detailed explanation of the project +- **Objectives**: List the main objectives to be achieved +- **Milestones**: Define key milestones with target dates and status +- **Resources**: List team members, budget, and tools +- **Risks**: Identify potential risks with mitigation strategies +- **Notes**: Add any additional relevant information + +### Step 4: Update the Dashboard + +1. Navigate to `pmo/artifacts/dashboard/` +2. Update the `DASHBOARD_TEMPLATE.md` or create a current dashboard file: + - Add the project to the "Project Overview" table + - Update the "Status Distribution", "Priority Distribution", and "Health Indicators" counts + - Add the project to the "Priority Queue" if appropriate + - Include any recent activity in the "Recent Activity" table + - Update the "Summary Statistics" +3. Update the "Last Updated" timestamp +4. Consider the project's timeline in the "Timeline View" + +### Step 5: Review and Validate + +1. Ensure all required fields are filled out correctly +2. Verify that the tracking URL is accessible +3. Double-check dates and percentages for accuracy +4. Confirm the project priority and health status are appropriate +5. Ensure the next milestone is clearly defined + +## Best Practices + +- **Be Consistent**: Use consistent terminology and formatting across all projects +- **Keep It Current**: Regularly update project status and progress +- **Link Don't Duplicate**: Provide links to detailed tracking systems rather than duplicating information +- **Prioritize Accuracy**: Ensure health and priority indicators accurately reflect project status +- **Use Clear IDs**: Use meaningful project IDs that help identify the project type +- **Update Regularly**: Update the dashboard when project status changes + +## AI Agent Integration + +If you're using AI agents to manage projects: + +- Use the JSON format for better machine readability +- Maintain consistent field values to enable automated processing +- Update the `last_updated` field whenever changes are made +- Follow the established schema to ensure compatibility + +## Example + +For a reference implementation, see the sample project: +`pmo/artifacts/projects/SAMPLE-001_DemoProject.md` + +## Troubleshooting + +**Problem**: Not sure what priority to assign? +**Solution**: Use this guide: +- Critical: Project blocks other work or has immediate business impact +- High: Important project with near-term deadlines +- Medium: Standard project with moderate importance +- Low: Nice-to-have or long-term project + +**Problem**: Not sure what health status to assign? +**Solution**: Use this guide: +- Green: Project is on track, no significant issues +- Yellow: Project has some concerns, monitoring needed +- Red: Project has significant issues requiring immediate attention + +## Maintenance + +- Review project statuses regularly (weekly recommended) +- Archive completed projects to a separate directory +- Update dependencies when they change +- Clean up outdated information periodically \ No newline at end of file diff --git a/pmo/artifacts/docs/index.md b/pmo/artifacts/docs/index.md index d54243b..86e3caf 100644 --- a/pmo/artifacts/docs/index.md +++ b/pmo/artifacts/docs/index.md @@ -6,6 +6,7 @@ This directory contains detailed documentation for the Project Management Office - [Dashboard Documentation](./dashboard.md) - Information about PMO dashboards - [Project Registry Documentation](./projects.md) - Information about project tracking +- [Add Project Guide](./add-project-guide.md) - Guide for adding new projects to the PMO - [Report Generation](./reports.md) - Information about status reports - [Resource Management](./resources.md) - Information about resource tracking - [Configuration Guide](./config.md) - Information about PMO configuration diff --git a/pmo/artifacts/projects/PROJECT_TEMPLATE.md b/pmo/artifacts/projects/PROJECT_TEMPLATE.md new file mode 100644 index 0000000..97a9429 --- /dev/null +++ b/pmo/artifacts/projects/PROJECT_TEMPLATE.md @@ -0,0 +1,49 @@ +# Project Template + +## Project Information + +| Field | Value | +|-------|-------| +| **Name** | [Project Name] | +| **ID** | [Unique Project ID] | +| **Status** | Active / On Hold / Completed / Planned | +| **Priority** | Critical / High / Medium / Low | +| **Health** | Green / Yellow / Red | +| **Last Updated** | YYYY-MM-DD HH:MM:SS | +| **Tracking URL** | [Link to project-specific tracking system] | +| **Owner** | [Project owner] | +| **Dependencies** | [Other projects this project depends on] | +| **Due Date** | [Key milestone or completion date] | +| **Progress** | [Percentage complete] | +| **Next Milestone** | [Next major milestone to achieve] | + +## Project Details + +### Description +[Detailed description of the project] + +### Objectives +- [ ] [Objective 1] +- [ ] [Objective 2] +- [ ] [Objective 3] + +### Milestones +| Milestone | Target Date | Status | +|-----------|-------------|--------| +| [Milestone 1] | [Date] | Not Started / In Progress / Completed | +| [Milestone 2] | [Date] | Not Started / In Progress / Completed | +| [Milestone 3] | [Date] | Not Started / In Progress / Completed | + +### Resources +- Team Members: [List of contributors] +- Budget: [If applicable] +- Tools: [List of tools used for this project] + +### Risks +| Risk | Impact | Mitigation Strategy | +|------|--------|-------------------| +| [Risk 1] | [High/Medium/Low] | [How to mitigate] | +| [Risk 2] | [High/Medium/Low] | [How to mitigate] | + +### Notes +[Any additional notes about the project] \ No newline at end of file diff --git a/pmo/artifacts/projects/README.md b/pmo/artifacts/projects/README.md new file mode 100644 index 0000000..27be38e --- /dev/null +++ b/pmo/artifacts/projects/README.md @@ -0,0 +1,48 @@ +# PMO Project Registry + +This directory contains all registered projects in the PMO system. Each project should follow the standardized schema defined in the PMO proposal. + +## Project Entry Templates + +- `PROJECT_TEMPLATE.md` - Human-readable template for project entries +- `project-template.json` - Machine-readable template for AI processing + +## Adding a New Project + +To add a new project to the registry: + +1. Copy the project template that best suits your needs +2. Fill in all required fields according to the schema +3. Save the file with a descriptive name (e.g., `{PROJECT_ID}_{PROJECT_NAME}.md` or `{PROJECT_ID}_{PROJECT_NAME}.json`) +4. Update the main dashboard to reflect the new project + +## Project Schema + +Each project entry should contain: + +| Field | Description | Required | +|-------|-------------|----------| +| `name` | Project name (human readable) | Yes | +| `id` | Unique identifier | Yes | +| `status` | Current status (Active, On Hold, Completed, Planned) | Yes | +| `priority` | Priority level (Critical, High, Medium, Low) | Yes | +| `health` | Health indicator (Green, Yellow, Red) | Yes | +| `last_updated` | Timestamp of last status update | Yes | +| `tracking_url` | Link to project-specific tracking | Yes | +| `owner` | Project owner | No | +| `dependencies` | Other projects this project depends on | No | +| `due_date` | Key milestone or completion date | No | +| `progress` | Percentage complete | Yes | +| `next_milestone` | Next major milestone to achieve | Yes | + +## Project Status Values + +- **Status**: `Active`, `On Hold`, `Completed`, `Planned` +- **Priority**: `Critical`, `High`, `Medium`, `Low` +- **Health**: `Green`, `Yellow`, `Red` + +## File Naming Convention + +Use the format: `{PROJECT_ID}_{PROJECT_NAME}.{md|json}` + +Example: `PROJ-001_EcommercePlatform.md` \ No newline at end of file diff --git a/pmo/artifacts/projects/SAMPLE-001_DemoProject.json b/pmo/artifacts/projects/SAMPLE-001_DemoProject.json new file mode 100644 index 0000000..bf9aa52 --- /dev/null +++ b/pmo/artifacts/projects/SAMPLE-001_DemoProject.json @@ -0,0 +1,72 @@ +{ + "name": "Demo Project", + "id": "SAMPLE-001", + "status": "Active", + "priority": "Medium", + "health": "Green", + "last_updated": "2025-10-24 10:00:00", + "tracking_url": "https://github.com/example/demo-project", + "owner": "Project Owner", + "dependencies": [], + "due_date": "2025-12-31", + "progress": 25, + "next_milestone": "Complete initial design phase", + "description": "This is a sample project created to demonstrate the PMO project registry functionality. It serves as an example of how projects should be structured and tracked within the PMO system.", + "objectives": [ + "Set up project structure", + "Complete initial design phase", + "Implement core features", + "Testing and validation", + "Project completion" + ], + "milestones": [ + { + "name": "Project Setup", + "target_date": "2025-10-20", + "status": "Completed" + }, + { + "name": "Initial Design", + "target_date": "2025-11-15", + "status": "In Progress" + }, + { + "name": "Feature Implementation", + "target_date": "2025-11-30", + "status": "Not Started" + }, + { + "name": "Testing", + "target_date": "2025-12-15", + "status": "Not Started" + }, + { + "name": "Project Completion", + "target_date": "2025-12-31", + "status": "Not Started" + } + ], + "resources": { + "team_members": [ + "Project Owner" + ], + "budget": "Demo project", + "tools": [ + "GitHub", + "Documentation tools" + ] + }, + "risks": [ + { + "risk": "Scope creep", + "impact": "Medium", + "mitigation_strategy": "Clearly defined objectives and scope" + }, + { + "risk": "Resource availability", + "impact": "Low", + "mitigation_strategy": "Single owner, flexible timeline" + } + ], + "notes": "This is a demonstration project for the PMO system. It shows how projects should be documented and tracked according to the established schema." +} \ No newline at end of file diff --git a/pmo/artifacts/projects/SAMPLE-001_DemoProject.md b/pmo/artifacts/projects/SAMPLE-001_DemoProject.md new file mode 100644 index 0000000..044dc91 --- /dev/null +++ b/pmo/artifacts/projects/SAMPLE-001_DemoProject.md @@ -0,0 +1,53 @@ +# Sample Project: Demo Project + +## Project Information + +| Field | Value | +|-------|-------| +| **Name** | Demo Project | +| **ID** | SAMPLE-001 | +| **Status** | Active | +| **Priority** | Medium | +| **Health** | Green | +| **Last Updated** | 2025-10-24 10:00:00 | +| **Tracking URL** | https://github.com/example/demo-project | +| **Owner** | Project Owner | +| **Dependencies** | None | +| **Due Date** | 2025-12-31 | +| **Progress** | 25% | +| **Next Milestone** | Complete initial design phase | + +## Project Details + +### Description +This is a sample project created to demonstrate the PMO project registry functionality. It serves as an example of how projects should be structured and tracked within the PMO system. + +### Objectives +- [x] Set up project structure +- [ ] Complete initial design phase +- [ ] Implement core features +- [ ] Testing and validation +- [ ] Project completion + +### Milestones +| Milestone | Target Date | Status | +|-----------|-------------|--------| +| Project Setup | 2025-10-20 | Completed | +| Initial Design | 2025-11-15 | In Progress | +| Feature Implementation | 2025-11-30 | Not Started | +| Testing | 2025-12-15 | Not Started | +| Project Completion | 2025-12-31 | Not Started | + +### Resources +- Team Members: Project Owner +- Budget: $0 (Demo project) +- Tools: GitHub, Documentation tools + +### Risks +| Risk | Impact | Mitigation Strategy | +|------|--------|-------------------| +| Scope creep | Medium | Clearly defined objectives and scope | +| Resource availability | Low | Single owner, flexible timeline | + +### Notes +This is a demonstration project for the PMO system. It shows how projects should be documented and tracked according to the established schema. \ No newline at end of file diff --git a/pmo/artifacts/projects/project-template.json b/pmo/artifacts/projects/project-template.json new file mode 100644 index 0000000..ddbd287 --- /dev/null +++ b/pmo/artifacts/projects/project-template.json @@ -0,0 +1,45 @@ +{ + "name": "[Project Name]", + "id": "[Unique Project ID]", + "status": "Active", + "priority": "Medium", + "health": "Green", + "last_updated": "YYYY-MM-DD HH:MM:SS", + "tracking_url": "[Link to project-specific tracking system]", + "owner": "[Project owner]", + "dependencies": [], + "due_date": "[Key milestone or completion date]", + "progress": 0, + "next_milestone": "[Next major milestone to achieve]", + "description": "[Detailed description of the project]", + "objectives": [ + "[Objective 1]", + "[Objective 2]", + "[Objective 3]" + ], + "milestones": [ + { + "name": "[Milestone 1]", + "target_date": "[Date]", + "status": "Not Started" + }, + { + "name": "[Milestone 2]", + "target_date": "[Date]", + "status": "Not Started" + } + ], + "resources": { + "team_members": [], + "budget": null, + "tools": [] + }, + "risks": [ + { + "risk": "[Risk 1]", + "impact": "Medium", + "mitigation_strategy": "[How to mitigate]" + } + ], + "notes": "[Any additional notes about the project]" +} \ No newline at end of file