Project Workspace¶
Purpose¶
The Project Workspace is the place where a team organizes the actual evidence for a project.
This section does not duplicate the Template Library. Instead, each workspace page shows what belongs in that directory and links directly to:
- the corresponding Template Library artifacts, and
- the completed LMU/COICP example artifacts.
That keeps the Template Library as the source of reusable guidance, the Examples area as the source of completed reference artifacts, and the Project Workspace as the structure a team uses for its own repository.
How the three areas work together¶
| Area | Role | Use It When |
|---|---|---|
docs/template-library/ |
Reusable artifact guidance | You need a starting point for a project artifact. |
docs/examples/lmu-coicp/ |
Completed reference implementation | You want to see what a filled-in artifact looks like. |
docs/project-workspace/ |
Project evidence workspace | You are organizing or populating the actual project repository. |
Directory structure¶
docs/project-workspace/
├── README.md
├── vision/
├── requirements/
├── planning/
├── architecture/
├── design/
├── implementation/
├── integration/
├── testing/
├── release/
├── operations/
├── deployment/
├── monitoring/
├── stewardship/
├── governance/
├── shared/
├── CHANGELOG.md
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── LICENSE
└── SECURITY.md
Lifecycle workspace¶
Vision
Business vision, problem definition, stakeholders, scope, assumptions, success metrics.
02Requirements
Requirements, constraints, use cases, traceability, review, readiness.
03Planning
Work breakdown, milestones, roles, risks, dependencies, estimates.
04Architecture
System context, components, evidence flow, quality strategy, AI controls, ADRs.
05Design
Interfaces, data, workflows, access control, AI interaction, exceptions, technical decisions.
06Implementation
Implementation readiness, AI use, branch workflow, work items, evidence, verification, reviews.
07Integration
Code review, AI implementation review, guardrail review, pull request review, integration verification.
08Testing
Test strategy, plan, cases, execution, defects, AI verification, guardrails, readiness summary.
09Release
Release candidate, scope, conditions, evidence, risk, guardrails, AI release review, release decision.
10Operations
Operational readiness, scope, runbooks, support, monitoring, rollback, transition, risks.
11Deployment
Deployment scope, plan, environment readiness, execution, rollback, transition, post-deployment checks.
12Monitoring
Operations monitoring, event logs, incident logs, risk updates, feedback, AI and guardrail monitoring.
13Stewardship
Post-release learning, lessons, feedback synthesis, improvement backlog, stewardship planning.
14Governance
Governance model, AI governance, release governance, evidence governance, risk and exception governance.
15Shared
Repository-wide project context and cross-stage working assets.
Repository files in this directory¶
| File | Purpose | Update Required |
|---|---|---|
CHANGELOG.md |
Records meaningful changes to the project workspace. | Replace placeholder entries with project-specific changes. |
CONTRIBUTING.md |
Defines contribution expectations. | Add branch, PR, reviewer, and evidence rules. |
CODE_OF_CONDUCT.md |
Sets collaboration expectations. | Confirm project or organization language. |
SECURITY.md |
Defines reporting and security expectations. | Add project-specific contact and data-handling guidance. |
LICENSE |
Records license selection. | Replace placeholder with the approved project license. |
How to use a workspace page¶
Each lifecycle directory README answers four questions:
- What belongs in this directory?
- Which templates should be used to create the project artifacts?
- Which LMU/COICP examples show completed artifacts?
- What evidence must exist before moving to the next stage?
Project rule¶
The project workspace is not a second template library. It is the place where project teams organize real evidence and use the Template Library and Examples area as guidance.