arckit-cli 6.1.1__py3-none-any.whl

arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/architecture-board-template.md

@@ -0,0 +1,194 @@
+---
+title: "Architecture Board Charter"
+docType: BORD
+templateVersion: "1.0"
+---
+
+# Architecture Board Charter
+
+## Document Control
+
+| Field | Value |
+|-------|-------|
+| Document ID | `ARC-[PROJECT_ID]-BORD-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. Board Charter
+
+### 1.1 Purpose
+
+[Purpose statement — why the Architecture Board exists, its mandate, and the governance objectives it serves. Reference TOGAF Phase G — Implementation Governance.]
+
+### 1.2 Scope
+
+**In scope:**
+
+- [Capabilities, domains, projects under the Board's governance]
+- [Architecture decisions requiring formal review]
+- [Compliance areas the Board oversees]
+
+**Out of scope:**
+
+- [Areas excluded from Board authority]
+- [Decisions reserved for other forums]
+
+### 1.3 Authority
+
+| Authority Level | Decision Type | Examples |
+|-----------------|---------------|----------|
+| Advisory | [Advisory decisions — recommendations only] | [Technology selection guidance, best practice recommendations] |
+| Mandatory | [Mandatory decisions — binding on all projects] | [Architecture principle exceptions, security design approval] |
+| Exception | [Exception process — formal deviation requests] | [Principle waiver requests, standard deviations] |
+
+---
+
+## 2. Membership
+
+### 2.1 Board Members
+
+| Role | Name | Organisation | Vote Type |
+|------|------|--------------|-----------|
+| Chair | `[CHAIR_NAME]` | `[CHAIR_ORG]` | Voting |
+| CISO | `[CISO_NAME]` | `[CISO_ORG]` | Voting |
+| Chief Architect | `[ARCHITECT_NAME]` | `[ARCH_ORG]` | Voting |
+| CTO | `[CTO_NAME]` | `[CTO_ORG]` | Voting |
+| Programme Sponsor | `[SPONSOR_NAME]` | `[SPONSOR_ORG]` | Observer |
+| Compliance Officer | `[COMPLIANCE_NAME]` | `[COMPLIANCE_ORG]` | Observer |
+
+### 2.2 Quorum
+
+[Minimum attendance requirements for valid decisions — e.g., "Minimum 4 voting members present, including the Chair, for decisions to be valid. Decisions made below quorum require retrospective approval at the next meeting."]
+
+---
+
+## 3. Decision Framework
+
+### 3.1 Voting Model
+
+| Model | When Used | Quorum Required |
+|-------|-----------|----------------|
+| Consensus | Standard decisions — principle alignment, architecture reviews | `[e.g., 75% of voting members]` |
+| Majority Vote | Time-sensitive decisions — project gating, resource allocation | `[50% + 1 of voting members]` |
+| Chair Decision | Deadlock resolution — when consensus and majority fail | `[Chair decides, documented with rationale]` |
+
+### 3.2 Escalation Path
+
+```mermaid
+flowchart LR
+    AB[Architecture Board] --> PB[Programme Board]
+    PB --> SC[Steering Committee]
+    SC --> EB[Executive Board]
+```
+
+### 3.3 Decision Recording
+
+All decisions must be recorded in the Decision Register with:
+
+- **Decision ID**: Unique identifier (DEC-BORD-NNN)
+- **Topic**: Subject of the decision
+- **Decision**: What was decided
+- **Rationale**: Why the decision was made
+- **Owner**: Who is responsible for implementation
+- **Status**: Active / Implemented / Superseded / Under Review
+
+---
+
+## 4. Compliance Scorecard
+
+### 4.1 Current State Assessment
+
+| Domain | Standard/Framework | Current State | Target State | Gap Description | Priority |
+|--------|-------------------|---------------|--------------|-----------------|----------|
+| Security | NCSC CAF | `[e.g., L3]` | `[e.g., L4]` | `[Gap description]` | `[High]` |
+| Data Architecture | DCAM | `[e.g., L2]` | `[e.g., L3]` | `[Gap description]` | `[Medium]` |
+| Application Portfolio | TOGAF Standards | `[e.g., L2]` | `[e.g., L3]` | `[Gap description]` | `[Medium]` |
+| Technology Standards | `[TCoP / Internal]` | `[e.g., L3]` | `[e.g., L4]` | `[Gap description]` | `[High]` |
+| Governance | COBIT 2019 | `[e.g., L2]` | `[e.g., L3]` | `[Gap description]` | `[Low]` |
+| Business Alignment | BSM | `[e.g., L3]` | `[e.g., L4]` | `[Gap description]` | `[Medium]` |
+
+### 4.2 Compliance Scoring Methodology
+
+- **Maturity model**: 1 (Initial) → 5 (Optimised)
+- **Gap severity**: Delta between current and target maturity
+- **Priority scoring**: Gap Size × Business Criticality
+- **Review cycle**: Quarterly reassessment
+
+---
+
+## 5. Exception Process
+
+### 5.1 Process Steps
+
+| Step | Action | Owner | Timeline | Approval |
+|------|--------|-------|----------|----------|
+| 1 | Exception request submitted | Requester | `[T+0]` | Self |
+| 2 | Impact assessment completed | Lead Architect | `[T+3 days]` | Architect |
+| 3 | Board review and deliberation | Architecture Board | `[T+7 days]` | Board |
+| 4 | Formal decision issued | Board Chair | `[T+14 days]` | Chair |
+| 5 | Appeal (if decision denied) | Original Requester | `[T+21 days]` | Programme Board |
+
+### 5.2 Exception Criteria
+
+**Valid exception must include:**
+
+- **Justification**: Business case for the deviation
+- **Impact assessment**: Risk, cost, schedule, security impact
+- **Duration**: Time-bound or permanent
+- **Compensating controls**: Alternative safeguards if principle is waived
+- **Review date**: When the exception expires or is reassessed
+
+### 5.3 Exception Register Template
+
+| Exception ID | Project | Principle | Request | Decision | Duration | Review Date | Status |
+|-------------|---------|-----------|---------|----------|----------|-------------|--------|
+| EXC-BORD-001 | `[Project]` | `[Principle]` | `[Request]` | `[Approved/Denied]` | `[Duration]` | `[Date]` | `[Active/Expired]` |
+
+---
+
+## 6. Review Cadence
+
+| Forum | Frequency | Participants | Agenda Items |
+|-------|-----------|--------------|--------------|
+| Architecture Board | Monthly | Board members, observers | Compliance review, exception decisions, new governance requests |
+| Programme Board | Monthly | Sponsor, PM, Board Chair | Architecture progress, risks, resource allocation |
+| Steering Committee | Quarterly | Executive sponsors | Strategic alignment, investment decisions, escalation resolution |
+| Executive Board | Semi-annually | C-suite, Board Chair | Architecture programme status, strategic decisions |
+
+---
+
+## 7. Decision Register
+
+| Date | Decision ID | Topic | Decision | Rationale | Owner | Status |
+|------|-------------|-------|----------|-----------|-------|--------|
+| `[YYYY-MM-DD]` | `DEC-BORD-001` | `[Topic]` | `[Decision]` | `[Rationale]` | `[Owner]` | `[Active/Implemented/Superseded/Under Review]` |
+
+---
+
+## 8. Traceability
+
+| Source Document | Document ID | Relationship |
+|-----------------|-------------|--------------|
+| Architecture Principles | `ARC-000-PRIN-v[N].md` | Board enforces principles compliance |
+| ADM Plan | `ARC-[P]-ADMP-v[N].md` | Board governs Phase G implementation |
+| Gap Analysis | `ARC-[P]-GAPA-v[N].md` | Board prioritises gap closure |
+| Architecture Change Requests | `ARC-[P]-ACHG-v[N].md` | Board approves/denies changes |
+
+---
+
+**Generated by**: ArcKit `/arckit:architecture-board` command
+**Generated on**: `[DATE] [TIME] GMT`
+**ArcKit Version**: `{ARCKIT_VERSION}`
+**Project**: `[PROJECT_NAME]` (Project `[PROJECT_ID]`)

arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/architecture-change-template.md

@@ -0,0 +1,205 @@
+---
+title: "Architecture Change Request"
+docType: ACHG
+templateVersion: "1.0"
+---
+
+# Architecture Change Request
+
+## Document Control
+
+| Field | Value |
+|-------|-------|
+| **Document ID** | `ARC-[PROJECT_ID]-ACHG-[ACHG_NUM]-v[VERSION]` |
+| **Document Type** | Architecture Change Request |
+| **Project** | `[PROJECT_NAME]` |
+| **Change ID** | `ACHG-[ACHG_NUM]` |
+| **Classification** | `[CLASSIFICATION]` |
+| **Status** | DRAFT |
+| **Change Type** | `[EVOLUTIONARY / TRANSFORMATIONAL / CORRECTIVE]` |
+| **Priority** | `[CRITICAL / HIGH / MEDIUM / LOW]` |
+| **Created Date** | `[YYYY-MM-DD]` |
+| **Last Modified** | `[YYYY-MM-DD]` |
+| **Review Date** | `[YYYY-MM-DD]` |
+| **Owner** | `[OWNER_NAME_AND_ROLE]` |
+| **Reviewed By** | `[REVIEWER_NAME]` |
+| **Approved By** | `[APPROVER_NAME]` |
+| **Distribution** | `[DISTRIBUTION_LIST]` |
+
+### Revision History
+
+| Version | Date | Author | Description | Reviewer | Approver |
+|---------|------|--------|-------------|----------|----------|
+| `[VERSION]` | `[YYYY-MM-DD]` | ArcKit AI | Initial creation from `/arckit:architecture-change` command | `[REVIEWER_NAME]` | `[APPROVER_NAME]` |
+
+---
+
+## 1. Change Request
+
+| Field | Value |
+|-------|-------|
+| Change ID | `ACHG-[ACHG_NUM]` |
+| Change Type | `[EVOLUTIONARY / TRANSFORMATIONAL / CORRECTIVE]` |
+| Submitted By | `[NAME]` |
+| Date | `[YYYY-MM-DD]` |
+| Priority | `[CRITICAL / HIGH / MEDIUM / LOW]` |
+
+---
+
+## 2. Rationale
+
+### 2.1 Business Driver
+
+[Why this change is needed from a business perspective. What objective or problem is being addressed?]
+
+### 2.2 Technical Driver
+
+[Architectural reason for the change — performance, security, scalability, maintainability, or compliance]
+
+### 2.3 Trigger
+
+[What initiated this change request: audit finding, strategic shift, technology obsolescence, stakeholder request, incident response]
+
+### 2.4 Change Description
+
+[Detailed description of the proposed change, including scope boundaries and exclusions]
+
+---
+
+## 3. Impact Assessment
+
+### 3.1 Capability Impact
+
+| Capability | Impact | Detail |
+|------------|--------|--------|
+| [C-X.X.X: Capability Name] | [Enhanced/Modified/New/Retired] | [Description of impact] |
+| [C-X.X.X: Capability Name] | [Enhanced/Modified/New/Retired] | [Description of impact] |
+
+### 3.2 Application Impact
+
+| Application | Impact | Detail |
+|-------------|--------|--------|
+| [Application Name] | [Enhanced/Modified/Replaced/Retired] | [Description of impact] |
+| [Application Name] | [Enhanced/Modified/Replaced/Retired] | [Description of impact] |
+
+### 3.3 Technology Impact
+
+| Technology | Impact | Detail |
+|------------|--------|--------|
+| [Technology/Platform] | [Enhanced/Modified/Replaced/Retired] | [Description of impact] |
+| [Technology/Platform] | [Enhanced/Modified/Replaced/Retired] | [Description of impact] |
+
+### 3.4 Governance Impact
+
+| Governance Area | Impact | Detail |
+|-----------------|--------|--------|
+| [Standards/Policy/Compliance] | [Changed/Unchanged/New] | [Description of impact] |
+| [Standards/Policy/Compliance] | [Changed/Unchanged/New] | [Description of impact] |
+
+---
+
+## 4. Affected Artefacts
+
+| Artefact | Impact Level | Action Required |
+|----------|-------------|-----------------|
+| `ARC-[PROJECT_ID]-BPCM-v[VERSION].md` | [HIGH / MEDIUM / LOW] | [Update / No change / New section] |
+| `ARC-[PROJECT_ID]-STRAT-v[VERSION].md` | [HIGH / MEDIUM / LOW] | [Update / No change / New section] |
+| `ARC-[PROJECT_ID]-APP-v[VERSION].md` | [HIGH / MEDIUM / LOW] | [Update / No change / New section] |
+| `ARC-[PROJECT_ID]-TRANS-v[VERSION].md` | [HIGH / MEDIUM / LOW] | [Update / No change / New section] |
+| `ARC-[PROJECT_ID]-ADMP-v[VERSION].md` | [HIGH / MEDIUM / LOW] | [Update / No change / New section] |
+
+---
+
+## 5. ADM Re-Entry Point
+
+| ADM Phase | Re-Entry | Scope |
+|-----------|----------|-------|
+| Phase A (Architecture Vision) | [YES / NO] | [Scope of re-entry] |
+| Phase B (Business Architecture) | [YES / NO] | [Scope of re-entry] |
+| Phase C (Information Systems Architectures) | [YES / NO] | [Scope of re-entry] |
+| Phase D (Technology Architecture) | [YES / NO] | [Scope of re-entry] |
+| Phase E (Opportunities & Solutions) | [YES / NO] | [Scope of re-entry] |
+| Phase F (Migration Planning) | [YES / NO] | [Scope of re-entry] |
+| Phase G (Implementation Governance) | [YES / NO] | [Scope of re-entry] |
+| Phase H (Architecture Change Management) | [YES / NO] | [Scope of re-entry] |
+
+---
+
+## 6. Cost/Benefit
+
+| Item | Amount |
+|------|--------|
+| Implementation Cost (CAPEX) | `[£X]` |
+| Ongoing Cost (OPEX/year) | `[£X/year]` |
+| Expected Benefit (year 1) | `[£Y]` |
+| Expected Benefit (annual) | `[£Y/year]` |
+| Payback Period | `[Z months]` |
+| 3-Year TCO | `[£X]` |
+
+### UK Government Financial Considerations
+
+| Item | Detail |
+|------|--------|
+| Spending Review Period | `[FY 2024/25 / FY 2025/26]` |
+| G-Cloud Frame | `[Frame reference if applicable]` |
+| TCoP Alignment | [Technology Code of Practice points addressed] |
+| Reuse Opportunity | [Cross-government service reuse assessment] |
+
+---
+
+## 7. Risk Assessment
+
+| Risk | Likelihood | Impact | Mitigation |
+|------|------------|--------|------------|
+| [Risk 1: Technical implementation risk] | [High/Medium/Low] | [High/Medium/Low] | [Mitigation strategy] |
+| [Risk 2: Operational disruption risk] | [High/Medium/Low] | [High/Medium/Low] | [Mitigation strategy] |
+| [Risk 3: Compliance/regulatory risk] | [High/Medium/Low] | [High/Medium/Low] | [Mitigation strategy] |
+| [Risk 4: Financial risk] | [High/Medium/Low] | [High/Medium/Low] | [Mitigation strategy] |
+
+---
+
+## 8. Approval Workflow
+
+| Stage | Owner | Decision | Date |
+|-------|-------|----------|------|
+| Submission | `[REQUESTER]` | Submitted | `[YYYY-MM-DD]` |
+| Assessment | `[ARCHITECT]` | [Pending/Approved/Rejected/Conditional] | `[YYYY-MM-DD]` |
+| Board Review | `[BOARD]` | [Pending/Approved/Rejected/Conditional] | `[YYYY-MM-DD]` |
+| Approval | `[BOARD_CHAIR]` | [Pending/Approved/Rejected/Conditional] | `[YYYY-MM-DD]` |
+| Implementation | `[TEAM]` | [Pending/Started/Complete] | `[YYYY-MM-DD]` |
+
+---
+
+## 9. Traceability
+
+### Change-to-Artefact Traceability
+
+| Source | Link | Target |
+|--------|------|--------|
+| `ARC-[PROJECT_ID]-BORD-v[VERSION].md` | → | `ACHG-[ACHG_NUM]` |
+| `ACHG-[ACHG_NUM]` | → | [List of affected artefacts] |
+| [ADR-XXX / STRAT / REQ] | → | `ACHG-[ACHG_NUM]` |
+
+### Cross-References
+
+| Reference | Type | Detail |
+|-----------|------|--------|
+| [ADR-XXX] | ADR | Related architecture decisions |
+| [REQ-XXX] | Requirement | Requirements addressed by this change |
+| [RISK-XXX] | Risk | Risks mitigated or created by this change |
+| [ACHG-XXX] | Change Request | Related change requests |
+
+### External References
+
+| ID | Source | Relevance |
+|----|--------|-----------|
+| [ACHG-E1] | [External document name] | [What it contributed] |
+
+---
+
+**Generated by**: ArcKit `/arckit:architecture-change` command
+**Generated on**: `[DATE] [TIME] GMT`
+**ArcKit Version**: `{ARCKIT_VERSION}`
+**Project**: `[PROJECT_NAME]` (Project `[PROJECT_ID]`)
+**AI Model**: `[MODEL_NAME]`
+**Generation Context**: [Brief note about source documents used]