arckit-cli 6.1.1__py3-none-any.whl

arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/service-assessment-prep-template.md

@@ -0,0 +1,448 @@
+# GDS Service Assessment Preparation Report
+
+> **Template Origin**: Official | **ArcKit Version**: [VERSION] | **Command**: `/arckit:service-assessment`
+
+## 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:service-assessment` command | PENDING | PENDING |
+
+---
+
+## Executive Summary
+
+**Overall Readiness**: [🟢 Green / 🟡 Amber / 🔴 Red]
+
+**Readiness Score**: [X]/14 points ready
+
+**Breakdown**:
+
+- 🟢 Green: [X] points
+- 🟡 Amber: [X] points
+- 🔴 Red: [X] points
+
+**Summary**:
+[2-3 paragraph summary of overall readiness, highlighting strengths and critical gaps]
+
+**Critical Gaps** (Must address before assessment):
+
+- [Gap 1 with Service Standard point number]
+- [Gap 2 with Service Standard point number]
+- [Gap 3 with Service Standard point number]
+
+**Key Strengths**:
+
+- [Strength 1]
+- [Strength 2]
+- [Strength 3]
+
+**Recommended Timeline**:
+[X weeks/days until ready based on gap analysis]
+[If assessment date provided: "Assessment in X days - [Ready/Need to postpone]"]
+
+---
+
+## Service Standard Assessment (14 Points)
+
+### 1. Understand Users and Their Needs
+
+**Status**: [🟢 Ready / 🟡 Partial / 🔴 Not Ready]
+
+**What This Point Means**:
+[Brief 2-3 sentence explanation of what this Service Standard point requires]
+
+**Why It Matters**:
+[1-2 sentences on importance]
+
+**Evidence Required for [Alpha/Beta/Live]**:
+
+- [Evidence requirement 1 for this phase]
+- [Evidence requirement 2 for this phase]
+- [Evidence requirement 3 for this phase]
+
+**Evidence Found in ArcKit Artifacts**:
+
+✅ **ARC-{PROJECT_ID}-REQ-v*.md** (lines XX-YY)
+
+- [Specific evidence found]
+- [What this demonstrates]
+
+✅ **ARC-{PROJECT_ID}-STKE-v*.md** (Section X)
+
+- [Specific evidence found]
+- [What this demonstrates]
+
+❌ **Missing**: [Specific gap 1]
+❌ **Missing**: [Specific gap 2]
+⚠️ **Weak**: [Evidence exists but lacks quality/detail]
+
+**Gap Analysis**:
+[2-3 sentences assessing completeness: what's strong, what's weak, what's missing]
+
+**Readiness Rating**: [🟢 Green / 🟡 Amber / 🔴 Red]
+
+**Strengths**:
+
+- [Strength 1]
+- [Strength 2]
+
+**Weaknesses**:
+
+- [Weakness 1]
+- [Weakness 2]
+
+**Recommendations**:
+
+1. **[Critical/High/Medium]**: [Action with specific details]
+   - Timeline: [X days/weeks]
+   - Owner: [Suggested role]
+   - Evidence to create: [What this will produce]
+
+2. **[Priority]**: [Action with specific details]
+   - Timeline: [X days/weeks]
+   - Owner: [Suggested role]
+   - Evidence to create: [What this will produce]
+
+**Assessment Day Guidance**:
+
+- **Prepare**: [What to prepare for presenting this point]
+- **Show**: [What to demonstrate/show]
+- **Bring**: [Who should be ready to present]
+- **Materials**: [Specific artifacts/demos to have ready]
+- **Likely Questions**:
+  - [Expected question 1]
+  - [Expected question 2]
+
+---
+
+[Repeat above structure for points 2-14]
+
+---
+
+## Evidence Inventory
+
+**Complete Traceability**: Service Standard Point → ArcKit Artifacts
+
+| Service Standard Point | ArcKit Artifacts | Status | Critical Gaps |
+|------------------------|------------------|--------|---------------|
+| 1. Understand users | [artifacts] | [🟢/🟡/🔴] | [gaps] |
+| 2. Solve whole problem | [artifacts] | [🟢/🟡/🔴] | [gaps] |
+| 3. Joined up experience | [artifacts] | [🟢/🟡/🔴] | [gaps] |
+| 4. Simple to use | [artifacts] | [🟢/🟡/🔴] | [gaps] |
+| 5. Everyone can use | [artifacts] | [🟢/🟡/🔴] | [gaps] |
+| 6. Multidisciplinary team | [artifacts] | [🟢/🟡/🔴] | [gaps] |
+| 7. Agile ways of working | [artifacts] | [🟢/🟡/🔴] | [gaps] |
+| 8. Iterate frequently | [artifacts] | [🟢/🟡/🔴] | [gaps] |
+| 9. Secure and private | [artifacts] | [🟢/🟡/🔴] | [gaps] |
+| 10. Success metrics | [artifacts] | [🟢/🟡/🔴] | [gaps] |
+| 11. Right tools | [artifacts] | [🟢/🟡/🔴] | [gaps] |
+| 12. Open source | [artifacts] | [🟢/🟡/🔴] | [gaps] |
+| 13. Open standards | [artifacts] | [🟢/🟡/🔴] | [gaps] |
+| 14. Reliable service | [artifacts] | [🟢/🟡/🔴] | [gaps] |
+
+**Summary**:
+
+- ✅ Strong evidence: Points [X, Y, Z]
+- ⚠️ Adequate but needs strengthening: Points [A, B, C]
+- ❌ Critical gaps: Points [D, E]
+
+---
+
+## Assessment Preparation Checklist
+
+### Critical Actions (Complete within 2 weeks)
+
+Priority: Complete these before booking assessment - they address Red ratings
+
+- [ ] **Action 1**: [Specific action]
+  - Point: [Service Standard point number]
+  - Timeline: [X days]
+  - Owner: [Role]
+  - Outcome: [What evidence this creates]
+
+- [ ] **Action 2**: [Specific action]
+  - Point: [Service Standard point number]
+  - Timeline: [X days]
+  - Owner: [Role]
+  - Outcome: [What evidence this creates]
+
+### High Priority Actions (Complete within 4 weeks)
+
+Priority: Should complete to strengthen Amber points to Green
+
+- [ ] **Action 3**: [Specific action]
+  - Point: [Service Standard point number]
+  - Timeline: [X days]
+  - Owner: [Role]
+  - Outcome: [What evidence this creates]
+
+### Medium Priority Actions (Nice to Have)
+
+Priority: Strengthens overall case but not blocking
+
+- [ ] **Action 5**: [Specific action]
+  - Point: [Service Standard point number]
+  - Timeline: [X days]
+  - Owner: [Role]
+  - Outcome: [What evidence this creates]
+
+---
+
+## Assessment Day Preparation
+
+### Timeline and Booking
+
+**Current Readiness**:
+[Assessment of whether ready to book now, or need to complete critical actions first]
+
+**Recommended Booking Timeline**:
+
+- Complete critical actions: [X weeks]
+- Complete high priority actions: [X weeks]
+- Buffer for preparation: 1 week
+- **Ready to book after**: [Date]
+
+**How to Book**:
+
+1. Contact GDS Central Digital & Data Office assessment team
+2. Book 5 weeks in advance minimum
+3. Assessments typically on Tuesday, Wednesday, or Thursday
+4. Duration: 4 hours
+5. Provide: Service name, department, phase, preferred dates
+
+### Documentation to Share with Panel
+
+**Send 1 week before assessment**:
+
+Required documentation:
+
+- [ ] Project overview (1-2 pages)
+- [ ] User research repository or summary
+- [ ] Service architecture diagrams
+- [ ] Prototype/demo environment URL (if applicable)
+
+Recommended documentation:
+
+- [ ] Key ArcKit artifacts: [list specific files]
+
+Optional supplementary:
+
+- [ ] Design history
+- [ ] Research findings
+- [ ] Technical documentation
+- [ ] Performance metrics dashboard
+
+### Who Should Attend
+
+**Core Team** (required):
+
+- ✅ Product Manager / Service Owner
+- ✅ Lead User Researcher
+- ✅ Technical Architect / Lead Developer
+- ✅ Delivery Manager
+
+**Phase-Specific Additions**:
+[List additional roles needed for this specific phase]
+
+**Optional Attendees**:
+
+- Senior Responsible Owner
+- Business owner
+- Specialists (as needed)
+
+### Show and Tell Structure
+
+**4-Hour Assessment Timeline**:
+
+**0:00-0:15 - Introductions and Context**
+
+- Team introductions
+- Service overview
+- Project context
+
+**0:15-1:00 - User Research and Needs (Points 1, 2, 3, 4)**
+
+- User Researcher presents research findings and methodology
+
+**1:00-1:45 - Service Demonstration (Points 2, 3, 4, 5)**
+
+- Show the service or prototype
+- End-to-end journey
+- Accessibility features
+
+**1:45-2:30 - Technical Architecture and Security (Points 9, 11, 12, 13, 14)**
+
+- Tech Lead presents architecture and technology choices
+
+**2:30-3:00 - Team and Ways of Working (Points 6, 7, 8, 10)**
+
+- Delivery Manager presents team and agile practices
+
+**3:00-3:45 - Open Q&A**
+
+- Panel asks questions
+- Team responds with evidence
+
+**3:45-4:00 - Panel Deliberation**
+
+- Team steps out
+
+### Tips for Success
+
+**Do**:
+
+- ✅ Show real work, not polished presentations
+- ✅ Have people who did the work present it
+- ✅ Be honest about what you don't know yet
+- ✅ Explain your problem-solving approach
+- ✅ Demonstrate iteration based on learning
+
+**Don't**:
+
+- ❌ Over-prepare presentations
+- ❌ Hide problems
+- ❌ Use jargon
+- ❌ Let senior leaders dominate
+- ❌ Argue with panel feedback
+
+**Materials to Have Ready**:
+
+- Prototype or working service
+- Laptops for team
+- Backup plan if demo breaks
+- Links to ArcKit artifacts
+- Research videos or clips
+- Architecture diagrams
+
+---
+
+## After the Assessment
+
+### If You Pass (Green)
+
+**Immediate Actions**:
+
+- [ ] Celebrate with the team
+- [ ] Share assessment report with stakeholders
+- [ ] Plan for next phase
+- [ ] Book next assessment (if moving to beta/live)
+
+### If You Get Amber
+
+**Immediate Actions**:
+
+- [ ] Create "tracking amber evidence" document
+- [ ] Assign owners to each amber point
+- [ ] Set deadlines (within 3 months)
+- [ ] Schedule check-ins with GDS team
+
+### If You Fail (Red)
+
+**Immediate Actions**:
+
+- [ ] Review assessment report with team
+- [ ] Identify root causes
+- [ ] Create action plan for each red point
+- [ ] Re-run `/arckit:service-assessment` weekly
+- [ ] Book reassessment (typically 3-6 months)
+
+---
+
+## Next Steps
+
+### This Week
+
+1. [Action from critical list]
+2. [Action from critical list]
+3. [Action from critical list]
+
+### Next 2 Weeks
+
+1. [Action from critical/high priority]
+2. [Action from critical/high priority]
+
+### Next 4 Weeks
+
+1. [Action from high priority]
+2. [Action from high priority]
+
+### Continuous Improvement
+
+- [ ] Re-run `/arckit:service-assessment PHASE=[phase]` weekly
+- [ ] Update this report as evidence gathered
+- [ ] Review checklist and mark completed items
+- [ ] Include Service Standard prep in sprint planning
+
+---
+
+## Resources
+
+### GDS Service Standard Resources
+
+**Official Guidance**:
+
+- [Service Standard](https://www.gov.uk/service-manual/service-standard)
+- [What happens at assessment](https://www.gov.uk/service-manual/service-assessments/how-service-assessments-work)
+- [Book assessment](https://www.gov.uk/service-manual/service-assessments/book-a-service-assessment)
+- [Service Standard Reports](https://www.gov.uk/service-standard-reports)
+
+**Phase-Specific Guidance**:
+
+- [Alpha phase](https://www.gov.uk/service-manual/agile-delivery/how-the-alpha-phase-works)
+- [Beta phase](https://www.gov.uk/service-manual/agile-delivery/how-the-beta-phase-works)
+- [Live phase](https://www.gov.uk/service-manual/agile-delivery/how-the-live-phase-works)
+
+### Related ArcKit Commands
+
+- `/arckit:analyze` - Comprehensive governance analysis
+- `/arckit:traceability` - Requirements traceability matrix
+- `/arckit:tcop` - Technology Code of Practice assessment
+- `/arckit:secure` - Secure by Design assessment
+
+## 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:service-assessment` command
+**Generated on**: [DATE]
+**ArcKit Version**: [VERSION]
+**Project**: [PROJECT_NAME]
+**Model**: [AI_MODEL]
+
+**Next Actions**:
+
+1. Review this report with your team
+2. Prioritize critical actions in sprint planning
+3. Re-run `/arckit:service-assessment PHASE=[phase]` weekly to track progress
+4. Use checklist to track completion of preparation tasks
+
+---
+
+*Good luck with your assessment! Show your work, explain your thinking, and be open to feedback.*

arckit_cli-6.1.1.data/data/share/arckit/.arckit/templates/servicenow-design-template.md

@@ -0,0 +1,273 @@
+# ServiceNow Service Design
+
+> **Template Origin**: Official | **ArcKit Version**: [VERSION] | **Command**: `/arckit:servicenow`
+
+## 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:servicenow` command | PENDING | PENDING |
+
+---
+
+## 1. Service Overview
+
+### Service Description
+
+[Brief description of the service - what business capability it provides]
+
+**Service Type**: [Application / Infrastructure / Business Service]
+**Service Owner**: [Team/Department]
+**Service Tier**: [Tier 1 Critical / Tier 2 Important / Tier 3 Standard]
+
+### Service Dependencies
+
+- **Upstream**: [Services this depends on]
+- **Downstream**: [Services that depend on this]
+
+---
+
+## 2. CMDB Design
+
+### Configuration Items
+
+[Derive CI hierarchy from architecture diagrams - Context/Container/Component layers map to Business Service/Application/Infrastructure CIs]
+
+| CI Name | CI Class | Parent CI | Owner | Environment |
+|---------|----------|-----------|-------|-------------|
+| [Service Name] | Business Service | - | [Team] | PROD |
+| [Application 1] | Application | [Service Name] | [Team] | PROD |
+| [Database 1] | Database | [Application 1] | [Team] | PROD |
+
+**Key CI Attributes**:
+
+- `u_service_tier`: [1/2/3]
+- `u_technology_stack`: [Languages/frameworks]
+- `u_repository_url`: [GitHub URL]
+- `u_health_check_url`: [Monitoring endpoint]
+
+---
+
+## 3. Service Level Agreements (SLAs)
+
+### Availability SLA
+
+[Derive from NFRs]
+
+| Service Tier | Availability | Max Downtime/Month |
+|--------------|--------------|-------------------|
+| Tier 1 | 99.95% | 21.9 minutes |
+| Tier 2 | 99.9% | 43.8 minutes |
+| Tier 3 | 99.5% | 3.65 hours |
+
+### Performance SLA
+
+[Derive from NFRs]
+
+| Transaction Type | Target (p95) | Target (p99) |
+|------------------|--------------|--------------|
+| [API GET] | [<500ms] | [<1000ms] |
+| [API POST] | [<1000ms] | [<2000ms] |
+
+### Support Coverage
+
+| Support Tier | Hours | On-Call | Response Times |
+|--------------|-------|---------|----------------|
+| Critical (P1/P2) | 24/7 | Yes | P1: 15min, P2: 1hr |
+| Standard (P3+) | Business hours | No | P3: 4hr, P4: 1 day |
+
+---
+
+## 4. Incident Management
+
+### Priority Matrix
+
+| Impact | Urgency High | Urgency Medium | Urgency Low |
+|--------|--------------|----------------|-------------|
+| **Critical** | P1 (15min/4hr) | P2 (1hr/8hr) | P3 (4hr/24hr) |
+| **High** | P2 (1hr/8hr) | P3 (4hr/24hr) | P4 (1d/3d) |
+| **Medium** | P3 (4hr/24hr) | P4 (1d/3d) | P4 (1d/5d) |
+| **Low** | P4 (1d/3d) | P4 (1d/5d) | P5 (2d/10d) |
+
+### Assignment Groups
+
+| Category | Subcategory | Assignment Group | Escalation |
+|----------|-------------|------------------|------------|
+| [Service]-Auth | Login Issues | [Team]-Auth-L2 | [Team]-Auth-L3 |
+| [Service]-API | 5xx Errors | [Team]-Backend-L2 | [Team]-Backend-L3 |
+| [Service]-DB | Performance | DBA-Support | DBA-Senior |
+
+### P1 Response Runbook
+
+1. **Detection** (0-5min): Auto-create incident, page on-call
+2. **Response** (5-15min): Acknowledge, join incident bridge
+3. **Diagnosis** (15-60min): Check dashboards, review logs
+4. **Mitigation** (60-240min): Fix or rollback
+5. **Resolution**: Verify, close incident, schedule PIR
+
+---
+
+## 5. Change Management
+
+### Change Categories
+
+| Type | Approval | Lead Time | Downtime |
+|------|----------|-----------|----------|
+| Standard | Auto-approved | 1 hour | None |
+| Normal | CAB | 5 days | Maintenance window |
+| Emergency | ECAB | 2 hours | Allowed 24/7 |
+
+### Maintenance Windows
+
+- **Standard**: [Day] [Time UTC], e.g. Sunday 02:00-06:00 UTC
+- **Blackout Periods**: [e.g., fiscal year-end, peak usage]
+
+### Rollback Criteria
+
+- [e.g., Error rate >5% for 10 minutes]
+- [e.g., Response time >3s for 5 minutes]
+
+---
+
+## 6. Monitoring & Alerting
+
+### Health Checks
+
+| Component | Endpoint | Frequency | Alert Threshold |
+|-----------|----------|-----------|-----------------|
+| [App 1] | /health | 30s | HTTP non-200 OR >2s |
+| [Database] | Connection | 60s | Connection fail |
+
+### Key Metrics
+
+| Metric | Threshold | Severity | Action |
+|--------|-----------|----------|--------|
+| Error Rate | >1% for 5min | P2 | Page on-call |
+| Error Rate | >5% for 5min | P1 | Page on-call + manager |
+| Response Time (p95) | >target for 10min | P3 | Create incident |
+| CPU Usage | >80% for 15min | P3 | Auto-scale + alert |
+
+### Dashboards
+
+- **Operational**: [Grafana/Datadog URL] - Real-time service health
+- **Business**: [BI tool URL] - Daily user/transaction metrics
+
+---
+
+## 7. Knowledge Management
+
+### Required Runbooks
+
+- [ ] Getting Started Guide (users)
+- [ ] Troubleshooting Guide (users + support)
+- [ ] Incident Response Runbook (operations)
+- [ ] Deployment Procedure (operations)
+- [ ] Rollback Procedure (operations)
+- [ ] DR Recovery Procedure (operations)
+
+**Review Schedule**: Runbooks reviewed quarterly, updated after major incidents
+
+---
+
+## 8. Go-Live Checklist
+
+### ServiceNow Configuration
+
+- [ ] Service CI created in CMDB with all child CIs
+- [ ] Service Catalog entry published
+- [ ] Incident categories and assignment groups configured
+- [ ] SLA definitions configured
+- [ ] Change templates created
+
+### Documentation
+
+- [ ] All runbooks written and tested
+- [ ] User guides published
+- [ ] Support team trained
+
+### Monitoring
+
+- [ ] Health checks configured
+- [ ] Dashboards created
+- [ ] Alert rules tested
+- [ ] On-call rotation staffed
+
+### Compliance
+
+- [ ] DPIA completed (if processing PII)
+- [ ] Security review passed
+- [ ] Accessibility audit passed (WCAG 2.2 AA)
+- [ ] ATRS published (if algorithmic system)
+
+---
+
+## 9. Requirements Traceability
+
+| Requirement ID | Requirement | ServiceNow Element | Status |
+|----------------|-------------|-------------------|--------|
+| [NFR-001] | 99.9% uptime | Availability SLA | ✅ |
+| [NFR-002] | <500ms response | Performance SLA | ✅ |
+| [NFR-003] | P1 response 15min | Incident SLA | ✅ |
+
+---
+
+## 10. UK Government Compliance
+
+### GDS Service Standard
+
+- **Point 5**: WCAG 2.2 AA compliance monitored
+- **Point 10**: Success metrics in ServiceNow dashboards
+- **Point 13**: Reuse common platforms (GOV.UK Notify, Pay)
+
+### ITIL v4 Practices
+
+- **Plan**: Change Management (CAB)
+- **Improve**: Post-Incident Reviews
+- **Engage**: Service Catalog
+- **Deliver & Support**: Incident Management, SLA monitoring
+
+---
+
+## Approval
+
+| Role | Name | Date |
+|------|------|------|
+| Service Owner | [Name] | |
+| Technical Lead | [Name] | |
+| IT Operations Manager | [Name] | |
+
+## 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:servicenow` command
+**Generated on**: [DATE]
+**ArcKit Version**: [VERSION]
+**Project**: [PROJECT_NAME]
+**Model**: [AI_MODEL]