mtkell
/
kell_creations
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
kell_creations/docs/architecture/traceability-index.md

233 lines
12 KiB
Markdown
Raw Permalink Blame History

# Traceability Index
This index provides a structured mapping between Kell Creations business domains, architecture views, dynamic workflows, and controlled governance documents.
## Purpose
The purpose of this index is to:
- connect business domains to architecture artifacts
- show which enterprise views support which applications
- show which workflows are documented
- link governance documents to the platform areas they control
- identify coverage gaps for future documentation
## How to Use This Index
Use this page to answer questions such as:
- Which architecture views apply to a given business domain?
- Which workflows have been documented for a given application?
- Which policies govern a given platform capability?
- What major architecture or governance gaps still need documentation?
---
## 1. Enterprise Architecture Traceability
| Enterprise View | File | Supports Domains |
| --------------------------------------------------- | ----------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ |
| System Landscape | `docs/architecture/system-landscape.md` | All domains |
| Platform Context | `docs/architecture/context/platform.md` | All domains |
| Platform Containers | `docs/architecture/containers/platform-containers.md` | All domains |
| Enterprise Shared Services | `docs/architecture/containers/enterprise-services.md` | All domains |
| Enterprise Data Architecture | `docs/architecture/containers/enterprise-data-architecture.md` | Inventory, MRP, WordPress, Social Media, Financial Analysis, Policy Repository |
| Enterprise Identity & Access Architecture | `docs/architecture/containers/enterprise-identity-access-architecture.md` | All application and governance domains |
| Enterprise Integration & Orchestration Architecture | `docs/architecture/containers/enterprise-integration-orchestration-architecture.md` | WordPress, Social Media, MRP, Inventory, Financial Analysis, Policy Repository |
| Enterprise Audit, Logging & Compliance Architecture | `docs/architecture/containers/enterprise-audit-logging-compliance-architecture.md` | All application and governance domains |
| Deployment Architecture | `docs/architecture/deployment/production.md` | All domains |
---
## 2. Application Component Traceability
| Application Domain | Component View | File | Related Enterprise Views |
| ------------------------- | ------------------------------------ | --------------------------------------------------------- | ------------------------------------------------------------ |
| Inventory | Inventory Components | `docs/architecture/components/inventory.md` | Shared Services, Data, Identity & Access, Audit, Integration |
| Craft Manufacturing / MRP | Craft Manufacturing / MRP Components | `docs/architecture/components/mrp.md` | Shared Services, Data, Identity & Access, Audit, Integration |
| WordPress Management | WordPress Management Components | `docs/architecture/components/wordpress-management.md` | Shared Services, Data, Identity & Access, Integration, Audit |
| Social Media Management | Social Media Management Components | `docs/architecture/components/social-media-management.md` | Shared Services, Data, Identity & Access, Integration, Audit |
| Financial Analysis | Financial Analysis Components | `docs/architecture/components/financial-analysis.md` | Shared Services, Data, Identity & Access, Audit |
---
## 3. Dynamic Workflow Traceability
| Workflow | File | Primary Domains | Related Component Views |
| --------------------------------------- | --------------------------------------------------------- | --------------------------------------------- | ------------------------------------------------------ |
| Order to Fulfillment | `docs/architecture/dynamic/order-to-fulfillment.md` | WordPress, Inventory, MRP, Financial Analysis | Inventory, MRP, WordPress, Financial Analysis |
| Product Publishing Workflow | `docs/architecture/dynamic/product-publishing.md` | WordPress Management, Shared Data | WordPress Management |
| Social Campaign Publishing Workflow | `docs/architecture/dynamic/social-campaign-publishing.md` | Social Media Management, Integration | Social Media Management |
| Inventory-to-Production Workflow | `docs/architecture/dynamic/inventory-to-production.md` | Inventory, MRP | Inventory, MRP |
| Policy Approval and Retirement Workflow | `docs/architecture/dynamic/policy-approval-retirement.md` | Governance, Policy Repository | Enterprise Audit, Identity & Access, Policy Repository |
---
## 4. Governance Document Traceability
| Governance Document | File | Governs Domains | Related Workflows / Views |
| -------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------- | ------------------------------------------------------------------------ |
| Document Control Policy | `docs/policies/governance/KC-POL-GOV-001-document-control-policy.md` | Governance, Policy Repository | Policy Approval and Retirement Workflow, Audit & Compliance Architecture |
| Policy Review and Retirement Procedure | `docs/policies/governance/KC-PRO-GOV-001-policy-review-and-retirement-procedure.md` | Governance, Policy Repository | Policy Approval and Retirement Workflow, Audit & Compliance Architecture |
---
## 5. Domain-to-Artifact Mapping
### Inventory
- Component View:
- `docs/architecture/components/inventory.md`
- Dynamic Workflows:
- `docs/architecture/dynamic/order-to-fulfillment.md`
- `docs/architecture/dynamic/inventory-to-production.md`
- Related Enterprise Views:
- Shared Services
- Data Architecture
- Identity & Access
- Audit & Compliance
- Integration & Orchestration
### Craft Manufacturing / MRP
- Component View:
- `docs/architecture/components/mrp.md`
- Dynamic Workflows:
- `docs/architecture/dynamic/order-to-fulfillment.md`
- `docs/architecture/dynamic/inventory-to-production.md`
- Related Enterprise Views:
- Shared Services
- Data Architecture
- Identity & Access
- Audit & Compliance
- Integration & Orchestration
### WordPress Management
- Component View:
- `docs/architecture/components/wordpress-management.md`
- Dynamic Workflows:
- `docs/architecture/dynamic/order-to-fulfillment.md`
- `docs/architecture/dynamic/product-publishing.md`
- Related Enterprise Views:
- Shared Services
- Data Architecture
- Identity & Access
- Integration & Orchestration
- Audit & Compliance
- Deployment
### Social Media Management
- Component View:
- `docs/architecture/components/social-media-management.md`
- Dynamic Workflows:
- `docs/architecture/dynamic/social-campaign-publishing.md`
- Related Enterprise Views:
- Shared Services
- Data Architecture
- Identity & Access
- Integration & Orchestration
- Audit & Compliance
### Financial Analysis
- Component View:
- `docs/architecture/components/financial-analysis.md`
- Dynamic Workflows:
- `docs/architecture/dynamic/order-to-fulfillment.md`
- Related Enterprise Views:
- Shared Services
- Data Architecture
- Identity & Access
- Audit & Compliance
### Governance / Policy Repository
- Governance Documents:
- `docs/policies/governance/KC-POL-GOV-001-document-control-policy.md`
- `docs/policies/governance/KC-PRO-GOV-001-policy-review-and-retirement-procedure.md`
- Dynamic Workflows:
- `docs/architecture/dynamic/policy-approval-retirement.md`
- Related Enterprise Views:
- Shared Services
- Identity & Access
- Audit & Compliance
- Deployment
---
## 6. Current Coverage Gaps
The following areas are strong candidates for future documentation:
!!! info "Last analyzed: 2026-05-22"
### Additional component views
- Policy Repository internal components
- Notification Service internal components
- API Orchestrator internal components
- Shared Data Repository internal components
- Documentation Platform internal components (MkDocs, PlantUML server, Forgejo runners)
### Additional dynamic workflows
- Financial close / reporting workflow
- Website change management workflow
- Exception handling workflow
- Marketing campaign analytics workflow
- Product image / media synchronization workflow
- Local development setup workflow
- Incident response workflow
### Additional governance documents
- Access Control Policy
- Social Media Publishing Standard
- Product Publishing Procedure
- Work Order Management Procedure
- Inventory Adjustment Procedure
- Financial Record Retention Policy
- Website Change Management Procedure
- Exception Management Standard
### Architecture decisions
- No formal ADRs exist; 7 candidate ADRs identified — see [ADR Index](decisions/index.md)
### Standards documents
- No formal standards documents exist; 10 candidate standards identified — see [Standards Overview](../standards/index.md)
### Operational procedures
- No operational runbooks exist; 5 candidate procedures identified — see [Operations Overview](../operations/index.md)
### Integration documentation
- Only WooCommerce integration is implemented; 5 additional integrations architecturally defined — see [Integrations Overview](../integrations/index.md)
### Documentation quality issues
- Enterprise Data Architecture page references wrong SVG diagram — **fixed 2026-05-22**
- Three architecture pages were missing "Diagram Source" references — **fixed 2026-05-22**
- Policy register CSVs are empty (header only) despite 2 active governance documents
- `feature_orders` package is missing standard scaffolding files (`.gitignore`, `.metadata`, `CHANGELOG.md`, `LICENSE`, `README.md`) present in all other packages
---
## 7. Maintenance Rules
This traceability index should be updated whenever any of the following occur:
- a new enterprise architecture view is added
- a new component view is added
- a new dynamic workflow is added
- a new controlled governance document is published
- a major domain or capability is renamed or restructured
## Summary
This traceability index is the navigation and governance bridge between architecture, workflows, business domains, and controlled documentation in the Kell Creations platform repository.
Reference in New Issue View Git Blame Copy Permalink