arckit-cli 6.1.1__py3-none-any.whl

arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/tcop-review-template.md

@@ -0,0 +1,593 @@
+# Technology Code of Practice (TCoP) Review
+
+> **Template Origin**: Official | **ArcKit Version**: [VERSION] | **Command**: `/arckit:tcop`
+
+## 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.[COMMAND]` command | [PENDING] | [PENDING] |
+
+## Document Purpose
+
+[Brief description of what this document is for and how it will be used]
+
+---
+
+## Executive Summary
+
+**Overall TCoP Compliance**: [Compliant / Partially Compliant / Non-Compliant]
+
+**Key Findings**:
+
+- [Summary of major compliance gaps]
+- [Summary of strengths]
+- [Critical actions required]
+
+---
+
+## TCoP Point 1: Define User Needs
+
+**Guidance**: Understand your users and their needs. Develop knowledge of your users and what that means for your technology project or programme.
+
+**Reference**: https://www.gov.uk/guidance/define-user-needs
+
+### Assessment
+
+**Status**: [✅ Compliant | ⚠️ Partially Compliant | ❌ Non-Compliant | N/A Not Applicable]
+
+**Evidence**:
+[Describe how user needs have been identified and documented]
+
+**User Research Conducted**:
+
+- [ ] User interviews completed
+- [ ] User personas created
+- [ ] User journey mapping done
+- [ ] Accessibility needs identified
+- [ ] Digital inclusion considerations documented
+
+**Gaps/Actions Required**:
+
+- [Action 1]
+- [Action 2]
+
+---
+
+## TCoP Point 2: Make Things Accessible and Inclusive
+
+**Guidance**: Make sure your technology, infrastructure and systems are accessible and inclusive for all users.
+
+**Reference**: https://www.gov.uk/guidance/make-things-accessible
+
+### Assessment
+
+**Status**: [✅ Compliant | ⚠️ Partially Compliant | ❌ Non-Compliant | N/A Not Applicable]
+
+**Evidence**:
+[Describe accessibility measures implemented]
+
+**Accessibility Standards**:
+
+- [ ] WCAG 2.2 Level AA compliance target set
+- [ ] Accessibility audit completed
+- [ ] Assistive technology testing done
+- [ ] Accessibility statement published
+- [ ] Regular accessibility testing scheduled
+
+**Gaps/Actions Required**:
+
+- [Action 1]
+- [Action 2]
+
+---
+
+## TCoP Point 3: Be Open and Use Open Source
+
+**Guidance**: Publish your code and use open source software to improve transparency, flexibility and accountability.
+
+**Reference**: https://www.gov.uk/guidance/be-open-and-use-open-source
+
+### Assessment
+
+**Status**: [✅ Compliant | ⚠️ Partially Compliant | ❌ Non-Compliant | N/A Not Applicable]
+
+**Evidence**:
+[Describe open source usage and code publication plans]
+
+**Open Source Practices**:
+
+- [ ] Code published in open repositories
+- [ ] Open source libraries used where appropriate
+- [ ] Contribution guidelines published
+- [ ] Open source licenses reviewed and documented
+- [ ] Proprietary software justified where used
+
+**Gaps/Actions Required**:
+
+- [Action 1]
+- [Action 2]
+
+---
+
+## TCoP Point 4: Make Use of Open Standards
+
+**Guidance**: Build technology that uses open standards to ensure your technology works and communicates with other technology, and can easily be upgraded and expanded.
+
+**Reference**: https://www.gov.uk/guidance/make-use-of-open-standards
+
+### Assessment
+
+**Status**: [✅ Compliant | ⚠️ Partially Compliant | ❌ Non-Compliant | N/A Not Applicable]
+
+**Evidence**:
+[Describe open standards adopted]
+
+**Open Standards Used**:
+
+- [ ] RESTful APIs with OpenAPI/Swagger specs
+- [ ] JSON/XML for data interchange
+- [ ] OAuth 2.0/OIDC for authentication
+- [ ] HTML5, CSS3 for web interfaces
+- [ ] Open standards documented in architecture
+
+**Gaps/Actions Required**:
+
+- [Action 1]
+- [Action 2]
+
+---
+
+## TCoP Point 5: Use Cloud First
+
+**Guidance**: Consider using public cloud solutions first as stated in the Cloud First policy.
+
+**Reference**: https://www.gov.uk/guidance/use-cloud-first
+
+### Assessment
+
+**Status**: [✅ Compliant | ⚠️ Partially Compliant | ❌ Non-Compliant | N/A Not Applicable]
+
+**Evidence**:
+[Describe cloud hosting approach]
+
+**Cloud First Considerations**:
+
+- [ ] Public cloud considered as first option
+- [ ] Cloud hosting decision documented
+- [ ] If not public cloud, justification documented
+- [ ] Cloud security controls implemented
+- [ ] Data residency requirements met (UK/EU)
+
+**Cloud Provider**: [AWS / Azure / GCP / Private Cloud / On-Premise]
+
+**Justification** (if not public cloud):
+[Explanation of why public cloud is not suitable]
+
+**Gaps/Actions Required**:
+
+- [Action 1]
+- [Action 2]
+
+---
+
+## TCoP Point 6: Make Things Secure
+
+**Guidance**: Keep systems and data safe with the appropriate level of security.
+
+**Reference**: https://www.gov.uk/guidance/make-things-secure
+
+### Assessment
+
+**Status**: [✅ Compliant | ⚠️ Partially Compliant | ❌ Non-Compliant | N/A Not Applicable]
+
+**Evidence**:
+[Describe security measures implemented]
+
+**Security Controls**:
+
+- [ ] Threat modelling completed
+- [ ] Security by design principles applied
+- [ ] Penetration testing planned/completed
+- [ ] Security risk register maintained
+- [ ] NCSC Cloud Security Principles assessed
+- [ ] Cyber Essentials / Cyber Essentials Plus certified
+- [ ] Data classification completed
+- [ ] Encryption at rest and in transit
+
+**Data Sensitivity**: [PUBLIC / OFFICIAL / OFFICIAL-SENSITIVE / SECRET]
+
+**Gaps/Actions Required**:
+
+- [Action 1]
+- [Action 2]
+
+---
+
+## TCoP Point 7: Make Privacy Integral
+
+**Guidance**: Make sure users' rights are protected by integrating privacy as an essential part of your system.
+
+**Reference**: https://www.gov.uk/guidance/make-privacy-integral
+
+### Assessment
+
+**Status**: [✅ Compliant | ⚠️ Partially Compliant | ❌ Non-Compliant | N/A Not Applicable]
+
+**Evidence**:
+[Describe privacy measures]
+
+**Privacy Controls**:
+
+- [ ] Data Protection Impact Assessment (DPIA) completed
+- [ ] Privacy by design principles applied
+- [ ] UK GDPR compliance assessed
+- [ ] Data retention policy defined
+- [ ] User consent mechanisms implemented
+- [ ] Data subject rights procedures documented
+- [ ] Privacy notice published
+- [ ] ICO registration completed (if required)
+
+**Personal Data Processed**: [Yes / No]
+
+**Gaps/Actions Required**:
+
+- [Action 1]
+- [Action 2]
+
+---
+
+## TCoP Point 8: Share, Reuse and Collaborate
+
+**Guidance**: Avoid duplicating effort and unnecessary costs by collaborating across government and sharing and reusing technology, data, and services.
+
+**Reference**: https://www.gov.uk/guidance/share-and-reuse-technology
+
+### Assessment
+
+**Status**: [✅ Compliant | ⚠️ Partially Compliant | ❌ Non-Compliant | N/A Not Applicable]
+
+**Evidence**:
+[Describe reuse and collaboration]
+
+**Reuse and Collaboration**:
+
+- [ ] Existing government services reviewed (GOV.UK, Notify, Pay, etc.)
+- [ ] Cross-government platforms used where appropriate
+- [ ] Technology components documented for reuse
+- [ ] APIs designed for reusability
+- [ ] Collaboration with other departments documented
+
+**Common Platforms Used**:
+
+- [ ] GOV.UK Notify
+- [ ] GOV.UK Pay
+- [ ] GOV.UK PaaS
+- [ ] Digital Marketplace
+- [ ] Other: [Specify]
+
+**Gaps/Actions Required**:
+
+- [Action 1]
+- [Action 2]
+
+---
+
+## TCoP Point 9: Integrate and Adapt Technology
+
+**Guidance**: Your technology should work with existing technologies, processes and infrastructure in your organisation, and adapt to future demands.
+
+**Reference**: https://www.gov.uk/guidance/integrate-and-adapt-technology
+
+### Assessment
+
+**Status**: [✅ Compliant | ⚠️ Partially Compliant | ❌ Non-Compliant | N/A Not Applicable]
+
+**Evidence**:
+[Describe integration approach]
+
+**Integration Considerations**:
+
+- [ ] Existing systems inventory completed
+- [ ] Integration points identified and documented
+- [ ] API strategy defined
+- [ ] Legacy system dependencies mapped
+- [ ] Future scalability considered
+- [ ] Technology roadmap aligned with organisational strategy
+
+**Key Integrations**:
+
+- [System 1]: [Integration method]
+- [System 2]: [Integration method]
+
+**Gaps/Actions Required**:
+
+- [Action 1]
+- [Action 2]
+
+---
+
+## TCoP Point 10: Make Better Use of Data
+
+**Guidance**: Use data more effectively by improving your technology, infrastructure and processes.
+
+**Reference**: https://www.gov.uk/guidance/make-better-use-of-data
+
+### Assessment
+
+**Status**: [✅ Compliant | ⚠️ Partially Compliant | ❌ Non-Compliant | N/A Not Applicable]
+
+**Evidence**:
+[Describe data strategy]
+
+**Data Management**:
+
+- [ ] Data architecture documented
+- [ ] Data quality standards defined
+- [ ] Master data management approach defined
+- [ ] Data analytics/insights strategy
+- [ ] Open data publication considered
+- [ ] Data sharing agreements in place (where needed)
+- [ ] Data lineage tracked
+
+**Gaps/Actions Required**:
+
+- [Action 1]
+- [Action 2]
+
+---
+
+## TCoP Point 11: Define Your Purchasing Strategy
+
+**Guidance**: Your purchasing strategy must show you've considered commercial and technology aspects, and contractual limitations.
+
+**Reference**: https://www.gov.uk/guidance/define-your-purchasing-strategy
+
+### Assessment
+
+**Status**: [✅ Compliant | ⚠️ Partially Compliant | ❌ Non-Compliant | N/A Not Applicable]
+
+**Evidence**:
+[Describe procurement approach]
+
+**Procurement Strategy**:
+
+- [ ] Market research conducted
+- [ ] Build vs buy decision documented
+- [ ] Digital Marketplace considered
+- [ ] Crown Commercial Service frameworks reviewed
+- [ ] Vendor lock-in risks assessed
+- [ ] Exit strategy defined
+- [ ] Social value considerations included
+- [ ] SME access considerations
+
+**Procurement Route**: [G-Cloud / DOS / Crown Commercial Service / Open Tender / Other]
+
+**Gaps/Actions Required**:
+
+- [Action 1]
+- [Action 2]
+
+---
+
+## TCoP Point 12: Make Your Technology Sustainable
+
+**Guidance**: Increase sustainability throughout the lifecycle of your technology.
+
+**Reference**: https://www.gov.uk/guidance/make-your-technology-sustainable
+
+### Assessment
+
+**Status**: [✅ Compliant | ⚠️ Partially Compliant | ❌ Non-Compliant | N/A Not Applicable]
+
+**Evidence**:
+[Describe sustainability measures]
+
+**Sustainability Considerations**:
+
+- [ ] Carbon footprint assessed
+- [ ] Energy-efficient infrastructure chosen
+- [ ] Device lifecycle management plan
+- [ ] E-waste disposal procedures
+- [ ] Green hosting/data centers considered
+- [ ] Sustainable procurement criteria applied
+- [ ] Remote/hybrid working enabled to reduce travel
+
+**Sustainability Metrics**:
+
+- Estimated carbon footprint: [kgCO2e per year]
+- Device refresh cycle: [Years]
+- Hosting energy source: [Renewable % / Grid mix]
+
+**Gaps/Actions Required**:
+
+- [Action 1]
+- [Action 2]
+
+---
+
+## TCoP Point 13: Meet the Service Standard
+
+**Guidance**: If you're building a service as part of your technology project or programme, you must meet the Service Standard.
+
+**Reference**: https://www.gov.uk/service-manual/service-standard
+
+### Assessment
+
+**Status**: [✅ Compliant | ⚠️ Partially Compliant | ❌ Non-Compliant | N/A Not Applicable]
+
+**Is this a public-facing service?**: [Yes / No]
+
+**Evidence**:
+[Describe Service Standard compliance]
+
+**Service Standard Compliance**:
+
+- [ ] Service assessments planned/completed
+- [ ] Agile, user-centered approach used
+- [ ] Performance metrics defined (KPIs)
+- [ ] Assisted digital support planned
+- [ ] Service manual guidance followed
+- [ ] Beta/live service assessment passed
+
+**Service Assessment Status**: [Not required / Planned / Alpha passed / Beta passed / Live passed]
+
+**Gaps/Actions Required**:
+
+- [Action 1]
+- [Action 2]
+
+---
+
+## Overall Compliance Summary
+
+### Compliance Scorecard
+
+| TCoP Point | Status | Critical Issues |
+|------------|--------|-----------------|
+| 1. Define user needs | [Status] | [Yes/No] |
+| 2. Make things accessible | [Status] | [Yes/No] |
+| 3. Be open and use open source | [Status] | [Yes/No] |
+| 4. Make use of open standards | [Status] | [Yes/No] |
+| 5. Use cloud first | [Status] | [Yes/No] |
+| 6. Make things secure | [Status] | [Yes/No] |
+| 7. Make privacy integral | [Status] | [Yes/No] |
+| 8. Share, reuse and collaborate | [Status] | [Yes/No] |
+| 9. Integrate and adapt technology | [Status] | [Yes/No] |
+| 10. Make better use of data | [Status] | [Yes/No] |
+| 11. Define your purchasing strategy | [Status] | [Yes/No] |
+| 12. Make your technology sustainable | [Status] | [Yes/No] |
+| 13. Meet the Service Standard | [Status] | [Yes/No] |
+
+**Overall Score**: [X/13 Compliant]
+
+### Critical Issues Requiring Immediate Action
+
+1. [Issue 1 with TCoP point reference]
+2. [Issue 2 with TCoP point reference]
+
+### Recommendations
+
+**High Priority**:
+
+- [Recommendation 1]
+- [Recommendation 2]
+
+**Medium Priority**:
+
+- [Recommendation 1]
+- [Recommendation 2]
+
+**Low Priority**:
+
+- [Recommendation 1]
+- [Recommendation 2]
+
+---
+
+## GovS 005 (Government Functional Standard for Digital) Alignment
+
+> **Note**: The Technology Code of Practice is the **implementation guidance** for [GovS 005 — Government Functional Standard for Digital](https://www.gov.uk/government/publications/government-functional-standard-govs-005-digital). Completing a TCoP review therefore covers the majority of GovS 005 requirements. The mapping below shows how each GovS 005 principle traces to TCoP points assessed above.
+
+### TCoP-to-GovS 005 Principle Mapping
+
+| GovS 005 Principle | Description | TCoP Points |
+|---------------------|-------------|-------------|
+| User-centred | Services designed around user needs | 1 (Define user needs), 2 (Accessible & inclusive) |
+| Open | Open source, open standards, transparency | 3 (Open source), 4 (Open standards) |
+| Secure | Proportionate security controls | 6 (Make things secure), 7 (Privacy integral) |
+| Technology | Cloud first, sustainable, integrated | 5 (Cloud first), 9 (Integrate & adapt), 12 (Sustainable) |
+| Data-driven | Evidence-based decisions using data | 10 (Make better use of data) |
+| Inclusive | Accessible to all users and communities | 2 (Accessible & inclusive), 13 (Service Standard) |
+| Collaborative | Share, reuse, work across boundaries | 8 (Share, reuse & collaborate) |
+| Commercially aware | Smart procurement, value for money | 11 (Purchasing strategy) |
+| Sustainable delivery | Lifecycle management, long-term viability | 12 (Sustainable), 9 (Integrate & adapt) |
+
+### GovS 005 Governance Obligations
+
+| Obligation | Status | Evidence / Notes |
+|------------|--------|------------------|
+| Senior Responsible Owner (SRO) appointed for digital function | [MET / NOT MET / N/A] | [Name or reference] |
+| Lifecycle stage identified (Discovery / Alpha / Beta / Live) | [MET / NOT MET / N/A] | [Current stage] |
+| CDDO digital spend control thresholds met | [MET / NOT MET / N/A] | [Spend amount and control reference] |
+| DDaT capability framework applied to team roles | [MET / NOT MET / N/A] | [Evidence of DDaT role mapping] |
+| Performance and status reported to the Permanent Secretary | [MET / NOT MET / N/A] | [Reporting cadence and method] |
+
+**Overall GovS 005 Alignment Status**: [ALIGNED / PARTIALLY ALIGNED / NOT ALIGNED]
+
+---
+
+## Next Steps
+
+**Immediate Actions** (0-30 days):
+
+- [ ] [Action 1]
+- [ ] [Action 2]
+
+**Short-term Actions** (1-3 months):
+
+- [ ] [Action 1]
+- [ ] [Action 2]
+
+**Long-term Actions** (3-12 months):
+
+- [ ] [Action 1]
+- [ ] [Action 2]
+
+**Review Schedule**: [Next review date]
+
+---
+
+## Approval
+
+| Role | Name | Date | Signature |
+|------|------|------|-----------|
+| Project Lead | [Name] | | |
+| Technical Architect | [Name] | | |
+| Senior Responsible Owner | [Name] | | |
+| Digital Spend Control (if applicable) | [Name] | | |
+
+---
+
+**Document Control**:
+
+- **Version**: 1.0
+- **Last Reviewed**: [Date]
+- **Next Review**: [Date, suggest quarterly]
+- **Document Owner**: [Name/Role]
+
+## 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:tcop` command
+**Generated on**: [DATE]
+**ArcKit Version**: [VERSION]
+**Project**: [PROJECT_NAME]
+**Model**: [AI_MODEL]

arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/tech-note-template.md

@@ -0,0 +1,59 @@
+# Tech Note: {TOPIC}
+
+> **Template Origin**: Official | **ArcKit Version**: [VERSION] | **Command**: `/arckit:research`
+
+## 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 |
+|---------|------|--------|---------|-------------|---------------|
+| 1.0 | {DATE} | ArcKit AI | Initial creation from `/arckit:research` agent | PENDING | PENDING |
+
+---
+
+## Summary
+
+{One-paragraph overview}
+
+## Key Findings
+
+{Bulleted findings from research}
+
+## Relevance to Projects
+
+{Which projects benefit from this knowledge}
+
+## 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:research` agent
+**Generated on**: {DATE}
+**ArcKit Version**: {VERSION}
+**Project**: {PROJECT_NAME}
+**Model**: {AI_MODEL}