arckit-cli 6.1.1__py3-none-any.whl

arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/analysis-report-template.md

@@ -0,0 +1,323 @@
+# Architecture Governance Analysis Report: [PROJECT_NAME]
+
+> **Template Origin**: Official | **ArcKit Version**: [VERSION] | **Command**: `/arckit:analyze`
+
+## Document Control
+
+<!-- DOC-CONTROL-HEADER -->
+<!-- Resolved at command-execution time to _partials/document-control-uk.md or _partials/document-control-uae.md based on plugin userConfig classification_scheme + governance_framework. See _partials/RENDERING.md (when present). -->
+
+## Revision History
+
+| Version | Date | Author | Changes | Approved By | Approval Date |
+|---------|------|--------|---------|-------------|---------------|
+| [VERSION] | [DATE] | ArcKit AI | Initial creation from `/arckit:analyze` command | PENDING | PENDING |
+
+---
+
+## Executive Summary
+
+**Overall Status**: [✅ Ready / ⚠️ Issues Found / ❌ Critical Issues]
+
+**Key Metrics**:
+
+- Total Requirements: [count]
+- Requirements Coverage: [percentage]%
+- Critical Issues: [count]
+- High Priority Issues: [count]
+- Medium Priority Issues: [count]
+- Low Priority Issues: [count]
+
+**Recommendation**: [PROCEED / RESOLVE CRITICAL ISSUES FIRST / MAJOR REWORK NEEDED]
+
+---
+
+## Findings Summary
+
+| ID | Category | Severity | Location(s) | Summary | Recommendation |
+|----|----------|----------|-------------|---------|----------------|
+| R1 | [Category] | [CRITICAL/HIGH/MEDIUM/LOW] | [file:line] | [Summary] | [Action] |
+| P1 | [Category] | [CRITICAL/HIGH/MEDIUM/LOW] | [file:line] | [Summary] | [Action] |
+| T1 | [Category] | [CRITICAL/HIGH/MEDIUM/LOW] | [file:line] | [Summary] | [Action] |
+
+---
+
+## Requirements Analysis
+
+### Requirements Coverage Matrix
+
+| Requirement ID | Type | Priority | Design Coverage | Tests Coverage | Status |
+|----------------|------|----------|-----------------|----------------|--------|
+| BR-001 | Business | MUST | [✅/❌] | [✅/❌] | [✅/⚠️/❌] |
+| FR-001 | Functional | MUST | [✅/❌] | [✅/❌] | [✅/⚠️/❌] |
+| NFR-S-001 | Security | MUST | [✅/❌] | [✅/❌] | [✅/⚠️/❌] |
+
+**Statistics**:
+
+- Total Requirements: [count]
+- Fully Covered: [count] ([percentage]%)
+- Partially Covered: [count] ([percentage]%)
+- Not Covered: [count] ([percentage]%)
+
+### Uncovered Requirements (CRITICAL)
+
+| Requirement ID | Priority | Description | Why Critical |
+|----------------|----------|-------------|--------------|
+| [REQ-ID] | MUST | [Description] | [Impact] |
+
+---
+
+## Architecture Principles Compliance
+
+| Principle | Status | Evidence | Issues |
+|-----------|--------|----------|--------|
+| [Principle Name] | [✅ COMPLIANT / ⚠️ PARTIAL / ❌ NON-COMPLIANT] | [Evidence] | [Issues] |
+
+**Critical Principle Violations**: [count]
+
+---
+
+## Stakeholder Traceability Analysis
+
+**Stakeholder Analysis Exists**: [✅ Yes / ❌ No]
+
+**Stakeholder-Requirements Coverage**:
+
+- Requirements traced to stakeholder goals: [percentage]%
+- Orphan requirements (no stakeholder justification): [count]
+- Requirement conflicts documented and resolved: [✅ Yes / ⚠️ Partial / ❌ No]
+
+**RACI Governance Alignment**:
+| Artifact | Role | Aligned with RACI? | Issues |
+|----------|------|-------------------|--------|
+| [Artifact] | [Role] | [✅ Yes / ❌ No] | [Issues] |
+
+---
+
+## Risk Management Analysis
+
+**Risk Register Exists**: [✅ Yes / ❌ No]
+
+**Risk Coverage**:
+| Risk ID | Category | Inherent | Residual | Response | Mitigation in Req? | Mitigation in Design? |
+|---------|----------|----------|----------|----------|-------------------|---------------------|
+| R-001 | [Category] | [Very High/High/Medium/Low] | [Score] | [4Ts] | [✅/❌] | [✅/❌] |
+
+**High/Very High Risks Requiring Attention**:
+| Risk ID | Description | Current Status | Required Action |
+|---------|-------------|----------------|-----------------|
+| [R-ID] | [Description] | [Status] | [Action] |
+
+---
+
+## Business Case Analysis
+
+**SOBC Exists**: [✅ Yes / ❌ No]
+
+**Benefits Traceability**:
+| Benefit ID | Description | Stakeholder Goal | Requirements | Measurable? | Status |
+|------------|-------------|------------------|--------------|-------------|--------|
+| B-001 | [Description] | [Goal ID] | [REQ IDs] | [✅/❌] | [Status] |
+
+**Benefits Coverage**:
+
+- Total benefits: [count]
+- Benefits traced to stakeholder goals: [percentage]%
+- Benefits supported by requirements: [percentage]%
+- Benefits measurable and verifiable: [percentage]%
+
+---
+
+## UK Government Compliance (if applicable)
+
+### Technology Code of Practice (TCoP)
+
+| TCoP Point | Status | Evidence | Gaps |
+|------------|--------|----------|------|
+| 1. Define user needs | [✅/⚠️/❌] | [Evidence] | [Gaps] |
+| 2. Make things accessible | [✅/⚠️/❌] | [Evidence] | [Gaps] |
+| [Continue for all 13 points...] | | | |
+
+**TCoP Score**: [X]/130 ([percentage]%)
+
+### AI Playbook Compliance (if AI system)
+
+**AI Playbook Assessment Exists**: [✅ Yes / ❌ No]
+**ATRS Record Exists**: [✅ Yes / ❌ No]
+
+### Secure by Design (if applicable)
+
+**SbD Assessment Exists**: [✅ Yes / ❌ No]
+**MOD SbD Score** (if MOD): [X]/70 ([percentage]%)
+
+---
+
+## Data Model Analysis (if ARC-*-DATA-v*.md exists)
+
+**Data Model Exists**: [✅ Yes / ❌ No]
+
+**Data Requirements Coverage**:
+| DR-ID | Entity | Covered in Model? | GDPR Basis | Issues |
+|-------|--------|-------------------|------------|--------|
+| DR-001 | [Entity] | [✅/❌] | [Basis] | [Issues] |
+
+---
+
+## Design Quality Analysis
+
+### HLD Analysis (if exists)
+
+**HLD Exists**: [✅ Yes / ❌ No]
+
+| Aspect | Status | Issues |
+|--------|--------|--------|
+| Requirements Coverage | [percentage]% | [Issues] |
+| Principles Alignment | [✅/⚠️/❌] | [Issues] |
+| Security Architecture | [✅/⚠️/❌] | [Issues] |
+| Integration Design | [✅/⚠️/❌] | [Issues] |
+
+### DLD Analysis (if exists)
+
+**DLD Exists**: [✅ Yes / ❌ No]
+
+| Aspect | Status | Issues |
+|--------|--------|--------|
+| HLD Alignment | [✅/⚠️/❌] | [Issues] |
+| Implementation Detail | [✅/⚠️/❌] | [Issues] |
+| Test Coverage | [✅/⚠️/❌] | [Issues] |
+
+---
+
+## Detailed Findings
+
+### Critical Issues
+
+#### [FINDING-ID]: [Finding Title]
+
+**Severity**: 🔴 CRITICAL
+**Category**: [Requirements Quality / Principles Alignment / Traceability / UK Gov Compliance / etc.]
+**Location**: [file:line or artifact reference]
+
+**Description**:
+[Detailed description of the issue]
+
+**Impact**:
+[What happens if this is not addressed]
+
+**Recommendation**:
+[Specific action to resolve]
+
+**Evidence**:
+
+- [Evidence 1]
+- [Evidence 2]
+
+---
+
+### High Priority Issues
+
+[Repeat structure for HIGH severity findings]
+
+---
+
+### Medium Priority Issues
+
+[Repeat structure for MEDIUM severity findings]
+
+---
+
+### Low Priority Issues
+
+[Repeat structure for LOW severity findings]
+
+---
+
+## Recommendations Summary
+
+### Immediate Actions (Before Procurement/Implementation)
+
+1. **[Action 1]**: [Description] - Addresses [FINDING-ID]
+2. **[Action 2]**: [Description] - Addresses [FINDING-ID]
+3. **[Action 3]**: [Description] - Addresses [FINDING-ID]
+
+### Short-term Actions (Within 2 weeks)
+
+1. **[Action 1]**: [Description]
+2. **[Action 2]**: [Description]
+
+### Medium-term Actions (Within 1 month)
+
+1. **[Action 1]**: [Description]
+2. **[Action 2]**: [Description]
+
+---
+
+## Appendix A: Artifacts Analyzed
+
+| Artifact | Location | Last Modified | Status |
+|----------|----------|---------------|--------|
+| Architecture Principles | `projects/000-global/ARC-000-PRIN-v*.md` | [Date] | [✅ Analyzed / ❌ Not Found] |
+| Stakeholder Drivers | `projects/[project]/ARC-*-STKE-v*.md` | [Date] | [✅ Analyzed / ❌ Not Found] |
+| Requirements | `projects/[project]/ARC-*-REQ-v*.md` | [Date] | [✅ Analyzed / ❌ Not Found] |
+| Risk Register | `projects/[project]/ARC-*-RISK-v*.md` | [Date] | [✅ Analyzed / ❌ Not Found] |
+| SOBC | `projects/[project]/ARC-*-SOBC-v*.md` | [Date] | [✅ Analyzed / ❌ Not Found] |
+| Data Model | `projects/[project]/ARC-*-DATA-v*.md` | [Date] | [✅ Analyzed / ❌ Not Found] |
+| HLD | `projects/[project]/vendors/[vendor]/hld-v1.md` | [Date] | [✅ Analyzed / ❌ Not Found] |
+| DLD | `projects/[project]/vendors/[vendor]/dld-v1.md` | [Date] | [✅ Analyzed / ❌ Not Found] |
+| TCoP Assessment | `projects/[project]/ARC-*-TCOP-*.md` | [Date] | [✅ Analyzed / ❌ Not Found] |
+| Traceability Matrix | `projects/[project]/ARC-*-TRAC-*.md` | [Date] | [✅ Analyzed / ❌ Not Found] |
+
+---
+
+## Appendix B: Analysis Methodology
+
+**Analysis Date**: [DATE]
+**Analyzed By**: ArcKit `/arckit:analyze` command
+
+**Checks Performed**:
+
+- Requirements completeness and quality
+- Architecture principles compliance
+- Stakeholder traceability
+- Risk coverage and mitigation
+- Business case alignment
+- UK Government compliance (if applicable)
+- Design quality (HLD/DLD)
+
+**Severity Classification**:
+
+- 🔴 **CRITICAL**: Blocks procurement/implementation, must resolve immediately
+- 🟠 **HIGH**: Significant risk, resolve before major milestones
+- 🟡 **MEDIUM**: Should be addressed, can proceed with caution
+- 🟢 **LOW**: Minor issues, address when convenient
+
+## External References
+
+> This section provides traceability from generated content back to source documents.
+> Follow citation instructions in the project's citation reference guide.
+
+### Document Register
+
+| Doc ID | Filename | Type | Source Location | Description |
+|--------|----------|------|-----------------|-------------|
+| *None provided* | — | — | — | — |
+
+### Citations
+
+| Citation ID | Doc ID | Page/Section | Category | Quoted Passage |
+|-------------|--------|--------------|----------|----------------|
+| — | — | — | — | — |
+
+### Unreferenced Documents
+
+| Filename | Source Location | Reason |
+|----------|-----------------|--------|
+| — | — | — |
+
+---
+
+**Generated by**: ArcKit `/arckit:analyze` command
+**Generated on**: [DATE]
+**ArcKit Version**: [VERSION]
+**Project**: [PROJECT_NAME]
+**Model**: [AI_MODEL]

arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/application-inventory-template.md

@@ -0,0 +1,221 @@
+---
+title: "Application Inventory"
+docType: APP
+templateVersion: "1.0"
+---
+
+# Application Inventory
+
+## Document Control
+
+| Field | Value |
+|-------|-------|
+| Document ID | `ARC-[PROJECT_ID]-APP-v[VERSION]` |
+| Project | `[PROJECT_NAME]` |
+| Owner | `[OWNER_NAME_AND_ROLE]` |
+| Classification | `[CLASSIFICATION]` |
+| Status | DRAFT |
+| Created | `[YYYY-MM-DD]` |
+| Review Date | `[YYYY-MM-DD]` |
+
+### Revision History
+
+| Version | Date | Author | Description | Reviewer | Approver |
+|---------|------|--------|-------------|----------|----------|
+| `[VERSION]` | `[YYYY-MM-DD]` | ArcKit AI | Initial creation | `[REVIEWER_NAME]` | `[APPROVER_NAME]` |
+
+---
+
+## 1. Application Register
+
+| App ID | Name | Category | Owner | Technology | Lifecycle | Status | Strategic Fit |
+|--------|------|----------|-------|-----------|-----------|--------|---------------|
+| APP-001 | `[Application Name]` | `[Category]` | `[Business Owner]` | `[Technology Stack]` | `[Lifecycle Phase]` | `[Active/Deprecated/Planned]` | `[Strategic/Critical/Support/Replace]` |
+| APP-002 | `[Application Name]` | `[Category]` | `[Business Owner]` | `[Technology Stack]` | `[Lifecycle Phase]` | `[Active/Deprecated/Planned]` | `[Strategic/Critical/Support/Replace]` |
+| APP-003 | `[Application Name]` | `[Category]` | `[Business Owner]` | `[Technology Stack]` | `[Lifecycle Phase]` | `[Active/Deprecated/Planned]` | `[Strategic/Critical/Support/Replace]` |
+
+> **Categories**: Line-of-Business, Shared Service, Platform, Customer-Facing, Internal Tool, Analytics, Integration, Data Store
+>
+> **Lifecycle Phases**: Concept, Discovery, Development, Operational, Mature, Declining, Retired
+>
+> **Strategic Fit**:
+>
+> - **Strategic** = Core to business strategy, competitive differentiator → *Invest & Grow*
+> - **Critical** = Essential for operations, commodity functionality → *Maintain & Optimise*
+> - **Support** = Supplementary, low value relative to cost → *Rationalise*
+> - **Replace** = High technical debt, misaligned with strategy → *Plan Replacement*
+
+## 2. Strategic Fit Matrix
+
+```mermaid
+quadrantChart
+    title Strategic Fit vs Technical Debt
+    x-axis__Low Debt --> High Debt
+    y-axis__Low Value --> High Value
+    quadrant-1 Keep & Invest
+    quadrant-2 Modernize
+    quadrant-3 Retire
+    quadrant-4 Monitor
+    %% Place applications here — format: [name, (x, y)]
+    "APP-001": [0.2, 0.9]
+    "APP-002": [0.7, 0.8]
+    "APP-003": [0.8, 0.2]
+    "APP-004": [0.3, 0.3]
+```
+
+### Fit Score Rationale
+
+| App ID | Business Value (1-5) | Technical Debt (1-5) | Quadrant | Recommended Action |
+|--------|---------------------|---------------------|----------|-------------------|
+| APP-001 | [Score] | [Score] | [Quadrant] | [Action] |
+
+## 3. Technology Landscape
+
+### Technology Distribution
+
+```mermaid
+pie title Technology Distribution
+    "Cloud-Native": 30
+    "Containerised": 25
+    "Virtualised": 25
+    "Physical": 20
+```
+
+### Technology Diversity
+
+| Technology Dimension | Count | Target | Status |
+|---------------------|-------|--------|--------|
+| Unique Runtimes | [N] | [Target] | [On-track/Over-target] |
+| Unique Platforms | [N] | [Target] | [On-track/Over-target] |
+| Unique Databases | [N] | [Target] | [On-track/Over-target] |
+| Unique Vendors | [N] | [Target] | [On-track/Over-target] |
+
+### Vendor Lock-in Risk
+
+| App ID | Vendor | Lock-in Risk | Exit Strategy |
+|--------|--------|-------------|---------------|
+| APP-001 | `[Vendor]` | `[High/Medium/Low]` | `[Exit plan]` |
+
+## 4. Application Dependencies
+
+```mermaid
+flowchart TD
+    %% Application dependency map
+    A[APP-001: Application 1] --> B[APP-002: Application 2]
+    B --> C[Shared Service]
+    A --> C
+    D[APP-003: Application 3] --> C
+    E[APP-004: Application 4] --> A
+    C --> F[Database]
+    B --> F
+```
+
+### Dependency Analysis
+
+| Dependency | Source | Target | Type | Criticality |
+|------------|--------|--------|------|------------|
+| `[Dependency Name]` | `[Source App]` | `[Target App]` | `[API/Database/File Share/Other]` | `[Critical/High/Medium/Low]` |
+
+### Shared Services
+
+| Service | Consumers | Technology | SLA |
+|---------|-----------|-----------|-----|
+| `[Service Name]` | `[Consumer Apps]` | `[Technology]` | `[SLA Level]` |
+
+## 5. Application-to-Capability Mapping
+
+| App ID | Capability ID | Capability Name | Coverage |
+|--------|---------------|-----------------|----------|
+| APP-001 | C1.1.1 | `[Capability Name]` | Full |
+| APP-002 | C1.2.1 | `[Capability Name]` | Partial |
+| APP-003 | C2.1.1 | `[Capability Name]` | Full |
+
+> **Coverage levels**:
+>
+> - **Full**: Application is the primary/sole system for this capability
+> - **Partial**: Application handles some aspects; other systems also contribute
+> - **Overlap**: Multiple applications cover the same capability (rationalisation candidate)
+>
+> **Gaps** (capabilities with no system coverage):
+> | Capability ID | Capability Name | Gap Impact |
+> |---------------|-----------------|------------|
+> | `[C-X.X.X]` | `[Capability]` | `[Impact]` |
+
+## 6. Application Lifecycle
+
+| App ID | Name | Age | EOL Date | Next Major Version | End of Life Plan |
+|--------|------|-----|----------|-------------------|------------------|
+| APP-001 | `[Name]` | `[Years]` | `[Date / N/A]` | `[Version]` | `[Plan / None]` |
+| APP-002 | `[Name]` | `[Years]` | `[Date / N/A]` | `[Version]` | `[Plan / None]` |
+| APP-003 | `[Name]` | `[Years]` | `[Date / N/A]` | `[Version]` | `[Plan / None]` |
+
+### Lifecycle Timeline
+
+```mermaid
+gantt
+    title Application Lifecycle Timeline
+    dateFormat YYYY-MM
+    section Active
+    APP-001 :active, a1, 2020-01, 2028-12
+    APP-002 :active, a2, 2018-06, 2026-06
+    section Declining
+    APP-003 :crit, a3, 2015-01, 2025-12
+    section Planned EOL
+    APP-002 EOL :milestone, m1, 2026-06, 1d
+    APP-003 EOL :milestone, m2, 2025-12, 1d
+```
+
+## 7. Risk Register
+
+| Risk ID | App ID | Risk | Category | Impact | Likelihood | Mitigation |
+|---------|--------|------|----------|--------|------------|------------|
+| RISK-001 | APP-001 | `[Risk description]` | `[Technical/Operational/Compliance/Strategic]` | `[High/Medium/Low]` | `[High/Medium/Low]` | `[Mitigation]` |
+| RISK-002 | APP-002 | `[Risk description]` | `[Technical/Operational/Compliance/Strategic]` | `[High/Medium/Low]` | `[High/Medium/Low]` | `[Mitigation]` |
+
+### Risk Categories
+
+- **Technical**: Unsupported technology, security vulnerabilities, scalability limits, performance degradation
+- **Operational**: Single point of failure, lack of skilled staff, poor documentation, vendor dependency
+- **Compliance**: Data residency, audit requirements, certification expiry, regulatory changes
+- **Strategic**: Misalignment with business direction, market obsolescence, vendor consolidation risk
+
+## 8. Traceability
+
+### Architecture Vision Alignment
+
+| ADMP Element | Application | Alignment | Notes |
+|--------------|-------------|-----------|-------|
+| `[Scope boundary]` | `[App IDs]` | `[In-scope/Out-of-scope]` | `[Notes]` |
+
+### Capability Coverage Trace
+
+| Source | Reference | Application Link |
+|--------|-----------|-----------------|
+| BPCM | `ARC-[P]-BPCM-v[VERSION].md` | `[Capability → App mapping summary]` |
+| REQ | `ARC-[P]-REQ-v[VERSION].md` | `[Requirement → App mapping summary]` |
+| PRIN | `ARC-000-PRIN-v[VERSION].md` | `[Principle → Technology alignment summary]` |
+
+### External References
+
+| Source | Document | Citation |
+|--------|----------|----------|
+| `[Source]` | `[Document Name]` | `[Reference]` |
+
+## 9. Assumptions
+
+1. `[Assumption about inventory completeness]`
+2. `[Assumption about data sources]`
+3. `[Assumption about strategic fit ratings]`
+
+## 10. Recommendations
+
+| Priority | Recommendation | Affected Apps | Effort | Impact |
+|----------|---------------|---------------|--------|--------|
+| `[High/Medium/Low]` | `[Recommendation]` | `[App IDs]` | `[High/Medium/Low]` | `[High/Medium/Low]` |
+
+---
+
+**Generated by**: ArcKit `/arckit:application-inventory` command
+**Generated on**: `[DATE] [TIME] GMT`
+**ArcKit Version**: `{ARCKIT_VERSION}`
+**Project**: `[PROJECT_NAME]` (Project `[PROJECT_ID]`)