arckit-cli 6.1.1__py3-none-any.whl

arckit_cli-6.1.1.data/data/share/arckit/docs/guides/presentation.md

@@ -0,0 +1,137 @@
+# Presentation Guide
+
+> **Guide Origin**: Official | **ArcKit Version**: [VERSION]
+
+`/arckit:presentation` produces a MARP-format slide deck from existing project artifacts — ideal for governance boards, stakeholder briefings, and gate reviews.
+
+---
+
+## Inputs
+
+- Multiple ArcKit artefacts committed (principles, stakeholders, requirements, plan, risk, diagrams, strategy).
+- At least 3 artefacts recommended for a meaningful presentation.
+- Optional: focus preference (executive, technical, stakeholder, procurement) and target slide count.
+
+---
+
+## Command
+
+```bash
+/arckit:presentation Generate executive presentation for <project>
+/arckit:presentation <project> FOCUS=technical SLIDES=15
+```
+
+Output: `projects/<id>/ARC-<id>-PRES-v1.0.md`
+
+> **Auto-versioning**: Re-running this command when a document already exists automatically increments the version (minor for refreshed content, major for changed focus/audience) instead of overwriting.
+
+---
+
+## What is MARP?
+
+[MARP](https://marp.app/) (Markdown Presentation Ecosystem) converts markdown files into presentations. ArcKit generates MARP-formatted markdown with `---` slide separators and YAML frontmatter. The output can be:
+
+- **Previewed** in VS Code with the [MARP extension](https://marketplace.visualstudio.com/items?itemName=marp-team.marp-vscode)
+- **Exported** to PDF, PPTX, or HTML via [MARP CLI](https://github.com/marp-team/marp-cli) (`marp --pdf`, `marp --pptx`)
+- **Read** as plain markdown without any tooling
+
+Mermaid diagrams (Gantt, pie, C4, quadrant) render natively in MARP.
+
+---
+
+## Presentation Focus Options
+
+| Focus | Audience | Emphasis | Typical Slides |
+|-------|----------|----------|---------------|
+| **Executive** | Board, SRO, Programme Director | Business case, timeline, risks, decisions needed | 10-12 |
+| **Technical** | Architects, developers, tech leads | Diagrams, technology decisions, integration, data model | 12-15 |
+| **Stakeholder** | Users, service owners, change teams | Benefits, user impact, timeline, change management | 10-12 |
+| **Procurement** | Commercial, vendors, evaluation panel | Requirements summary, evaluation criteria, contract structure | 10-12 |
+
+---
+
+## Presentation Structure
+
+| Slide | Content | Source Artefact |
+|-------|---------|----------------|
+| Title | Project name, date, classification | Project metadata |
+| Context & Objectives | Business challenge, strategic objectives, success criteria | STRAT, SOBC, REQ |
+| Stakeholder Landscape | Key stakeholders, influence/interest mapping | STKE |
+| Architecture Overview | Current → target state, C4 context diagram | DIAG, STRAT |
+| Technology Decisions | Key choices with rationale | RSCH, AWSR, AZUR, ADR |
+| Key Requirements | Category counts, critical requirements | REQ |
+| Risk Summary | Top risks, mitigation, distribution chart | RISK |
+| Roadmap & Timeline | Gantt chart, milestones, status | PLAN, ROAD |
+| Compliance & Governance | Standards compliance status | TCOP, SECD, MSBD, DPIA |
+| Recommendations & Next Steps | Actions, decisions, owners, deadlines | Synthesised |
+| Questions & Discussion | Contact, next review date | Project metadata |
+
+---
+
+## Mermaid Compatibility
+
+Mermaid's parser has strict label requirements — especially for `quadrantChart`:
+
+- **ASCII only**: No accented characters (é, í, ó, ñ, ü). Replace with plain equivalents (e→e, i→i).
+- **No hyphens in data point labels**: Use spaces — e.g., `DST Cybersecurity` not `DST-Cybersecurity`.
+- **No special characters**: Avoid colons, parentheses, brackets, or quotes in labels.
+
+If a chart fails to render, check labels for non-ASCII characters or hyphens first.
+
+---
+
+## Review Checklist
+
+- Content matches latest artefact versions (not stale data).
+- Slide count appropriate for meeting duration (rule of thumb: 2 minutes per slide).
+- Mermaid diagrams render correctly in MARP preview.
+- Classification banner matches project sensitivity.
+- No sensitive information on slides intended for wider distribution.
+- Stakeholder names and roles are current.
+- Dates and milestones reflect latest plan.
+- Recommendations have clear owners and deadlines.
+
+---
+
+## When to Regenerate
+
+| Moment | Rationale |
+|--------|-----------|
+| Before governance boards or gate reviews | Ensure latest data is presented |
+| After significant artefact updates | Refresh slides with new requirements, risks, or decisions |
+| When audience changes | Switch focus (e.g., executive → technical) |
+| Quarterly portfolio reviews | Consistent format across projects |
+| Before stakeholder workshops | Provide context and discussion framework |
+
+---
+
+## Rendering the Presentation
+
+**VS Code** (recommended for previewing):
+
+```bash
+# Install the MARP extension
+code --install-extension marp-team.marp-vscode
+# Open the .md file and click the MARP preview icon
+```
+
+**MARP CLI** (for export):
+
+```bash
+# Install
+npm install -g @marp-team/marp-cli
+
+# Export to PDF
+marp --pdf ARC-001-PRES-v1.0.md
+
+# Export to PowerPoint
+marp --pptx ARC-001-PRES-v1.0.md
+
+# Export to HTML
+marp ARC-001-PRES-v1.0.md
+
+# Custom theme
+marp --theme gaia --pdf ARC-001-PRES-v1.0.md
+```
+
+Store the presentation alongside project artefacts and share with stakeholders ahead of meetings.

arckit_cli-6.1.1.data/data/share/arckit/docs/guides/pricing.md

@@ -0,0 +1,62 @@
+# G-Cloud Pricing Guide
+
+> **Guide Origin**: Community | **ArcKit Version**: [VERSION]
+
+`/arckit:pricing` generates the pricing document for a G-Cloud service. It aligns prices to the
+service design, SDD, supplier evidence, and any market intelligence from tender or competitor
+artefacts.
+
+---
+
+## Command
+
+```bash
+/arckit:pricing <service project or service name>
+```
+
+Output:
+
+```text
+projects/<NNN>-<service-name>/ARC-<NNN>-PRIC-v1.0.md
+```
+
+---
+
+## When to Use
+
+- After `/arckit:service-design` and the relevant SDD command.
+- Before submission review, so pricing can be checked against service features and support model.
+- When tiers, units, day rates, discounts, trials, or education pricing need to be explicit.
+- When tender or competitor evidence should inform the pricing rationale.
+
+---
+
+## Inputs
+
+| Input | Purpose |
+|-------|---------|
+| Service design (`SVCD`) | Service scope, target buyers, features, and benefits |
+| Service Definition Document (`SDD`) | Marketplace-facing service detail |
+| Supplier profile (`SUPP`) | Currency, contact, insurance, and shared supplier context |
+| Tender or competitor artefacts | Optional benchmark evidence for price positioning |
+
+---
+
+## Output Sections
+
+| Section | Purpose |
+|---------|---------|
+| Pricing summary | Buyer-facing pricing model and headline tiers |
+| Units and assumptions | Licence, user, day-rate, usage, or package basis |
+| Included and excluded items | Clear boundary for each tier |
+| Discounts and trials | Education pricing, free trials, minimum terms, and extras |
+| Benchmark rationale | Evidence from market intelligence where available |
+
+---
+
+## Related Commands
+
+- `/arckit:tenders` - Procurement market benchmarks.
+- `/arckit:competitors` - Competitor award and positioning evidence.
+- `/arckit:gcloud-competitors` - Marketplace service comparison.
+- `/arckit:review` - Submission completeness and consistency check.

arckit_cli-6.1.1.data/data/share/arckit/docs/guides/principles-compliance.md

@@ -0,0 +1,63 @@
+# Principles Compliance Guide
+
+> **Guide Origin**: Official | **ArcKit Version**: [VERSION]
+
+`/arckit:principles-compliance` scores each architecture principle defined in `projects/000-global/ARC-000-PRIN-v1.0.md`, producing a RAG status with evidence and actions.
+
+---
+
+## Inputs
+
+| Artefact | Contribution |
+|----------|--------------|
+| Architecture principles | Source of truth for principle definitions, validation gates |
+| Requirements, designs, reviews | Evidence for compliance or gaps |
+| Risk register & exceptions | Track tolerances and remediation plans |
+
+---
+
+## Command
+
+```bash
+/arckit:principles-compliance <description>
+```
+
+Output saved as `projects/<id>/ARC-<id>-PRIN-COMP-v1.0.md`.
+
+---
+
+## Scorecard Structure
+
+| Column | Meaning | Typical Actions |
+|--------|---------|-----------------|
+| Principle | ID + summary | Ensure names align with governance library |
+| Status | ✅ / ⚠️ / ❌ / ⏳ (not assessed) | Address ❌ immediately; plan remediation for ⚠️ |
+| Evidence | Artefacts referenced (requirements, diagrams, reviews) | Confirm links resolve to current documents |
+| Actions | Required remediation, owner, due date | Track via backlog or governance board |
+
+---
+
+## Review Rhythm
+
+| Phase | Purpose |
+|-------|---------|
+| Discovery | Identify principles that will drive scope and constraints |
+| Alpha | Validate design proposals honour mandatory principles |
+| Beta | Confirm implementation evidence and service readiness |
+| Live / Quarterly | Detect drift, review exceptions, re-baseline actions |
+
+---
+
+## Checklist
+
+- Each principle has explicit evidence or clearly marked gap.
+- Exceptions include expiry date and accountable owner.
+- Actions feed into backlog with priority reflecting risk.
+- Summary recommends gate decision (Block / Conditional / Proceed).
+- Previous assessments archived for audit trail.
+
+---
+
+## Tip
+
+Use the generated scorecard as the backbone of design review meetings—walk through each principle, confirm status, and update actions live.

arckit_cli-6.1.1.data/data/share/arckit/docs/guides/principles.md

@@ -0,0 +1,55 @@
+# Architecture Principles Guide
+
+> **Guide Origin**: Official | **ArcKit Version**: [VERSION]
+
+`/arckit:principles` generates an organisation-wide set of architecture principles. Treat them as the contract for design decisions and compliance reviews.
+
+---
+
+## Quick Start
+
+```bash
+/arckit:principles Create architecture principles for <organisation>
+```
+
+Result: `projects/000-global/ARC-000-PRIN-v1.0.md`
+
+> **Auto-versioning**: Re-running this command when a document already exists automatically increments the version (minor for refreshed content, major for changed scope) instead of overwriting.
+
+---
+
+## Principle Template
+
+Use this structure when editing or adding principles:
+
+| Field | Description |
+|-------|-------------|
+| ID & Name | Short identifier (e.g. `CLOUD-001`) and descriptive title |
+| Statement | MUST / SHOULD statement that is testable |
+| Rationale | Why the principle exists (business, regulatory, technical) |
+| Evidence | Artefacts that demonstrate compliance (requirements, reviews, designs) |
+| Validation Gates | Checklist items used during `/arckit:principles-compliance` or design reviews |
+| Exceptions | Process, approver, expiry |
+
+Example snippet:
+
+```markdown
+### CLOUD-001 Cloud Native First
+**Statement**: New services MUST prefer managed or serverless cloud services unless an exception is approved.
+**Rationale**: Supports resilience, cost transparency, and platform operations model.
+**Validation Gates**:
+- [ ] Service uses managed PaaS/FaaS components (not bespoke VMs)
+- [ ] Infrastructure-as-Code committed to repo
+- [ ] Disaster recovery targets align with resilience policy
+**Exceptions**: Submit via Architecture Review Board; max 12 months with remediation plan.
+```
+
+---
+
+## Maintenance Tips
+
+- Review principles at least annually alongside enterprise strategy.
+- Flag deprecated principles but keep history for audit.
+- Link principles to relevant standards (TCoP, Cyber Essentials, ISO, internal policies).
+- Keep counts manageable (10–20 core principles plus domain extensions).
+- Use the same IDs in `/arckit:principles-compliance`, design reviews, and vendor contracts.

arckit_cli-6.1.1.data/data/share/arckit/docs/guides/procurement.md

@@ -0,0 +1,57 @@
+# Vendor Procurement Guide
+
+> **Guide Origin**: Official | **ArcKit Version**: [VERSION]
+
+ArcKit streamlines procurement through three commands:
+
+| Need | Command | Output |
+|------|---------|--------|
+| Statement of Work / RFP | `/arckit:sow` | `ARC-<id>-SOW-v1.0.md` with scope, requirements, deliverables, timeline, terms |
+| Evaluation Framework | `/arckit:evaluate` | `ARC-<id>-EVAL-v1.0.md` plus scoring spreadsheet |
+| Proposal Scoring | `/arckit:evaluate Score <vendor>` | `vendors/<vendor>/ARC-<id>-EVAL-<vendor>-v1.0.md` and comparison matrix |
+
+---
+
+## Decision Flow
+
+```text
+Requirements ready? → run /arckit:sow
+↓
+Agree evaluation criteria with stakeholders → /arckit:evaluate
+↓
+Receive proposals → /arckit:evaluate Score <vendor>
+↓
+/arckit:evaluate Compare vendors → board decision
+```
+
+---
+
+## Inputs Checklist
+
+- Finalised requirements (BR/FR/NFR/INT/DR) with priorities.
+- Architecture principles, Secure by Design requirements, compliance obligations.
+- Budget, commercial constraints, contract model.
+- Governance list (approvers, procurement board, commercial lead).
+
+---
+
+## Evaluation Template
+
+| Criterion Group | Typical Weight | Evidence |
+|-----------------|----------------|---------|
+| Technical capability | 40% | Alignment with requirements, architecture approach |
+| Delivery approach | 20% | Plan, resourcing, tooling, risk handling |
+| Compliance & security | 20% | Standards coverage (TCoP, Cyber Essentials, JSP 604, etc.) |
+| Commercials | 15% | Pricing transparency, TCO, payment schedule |
+| Social value / sustainability | 5% | UK government reporting obligations |
+
+Adjust to local policy (e.g. Cabinet Office commercial frameworks).
+
+---
+
+## Best Practice Tips
+
+- Include a supplier Q&A window; capture clarifications inside the SOW annex.
+- Run moderated scoring sessions; document consensus reasons in `comparison.md`.
+- Track mandatory gate checks (financial due diligence, security vetting) alongside evaluation.
+- Store all artefacts in `projects/<id>/vendors/` for audit and reuse.

arckit_cli-6.1.1.data/data/share/arckit/docs/guides/productivity.md

@@ -0,0 +1,217 @@
+# Architecture Productivity Guide
+
+> **Guide Origin**: Official | **ArcKit Version**: [VERSION]
+
+ArcKit generates architecture artifacts in Markdown, but governance boards, procurement panels, and senior stakeholders expect Word documents, PDF packs, slide decks, and spreadsheets. Anthropic's document skills bridge that gap — letting you convert ArcKit output into polished, client-ready deliverables without leaving Claude Code.
+
+---
+
+## Installing the Document Skills
+
+```text
+/plugin marketplace add anthropics/skills
+/plugin
+```
+
+Navigate to **Discover** > **anthropic-agent-skills** > **document-skills** and install. The skills work in both Claude Code and Claude Cowork.
+
+---
+
+## Skill-by-Skill Playbook
+
+### PDF (`/pdf`)
+
+Create sealed, read-only documents for compliance evidence and formal sign-off.
+
+| ArcKit Command | Why PDF |
+|----------------|---------|
+| `/arckit:secure` | Security assessment locked for audit trail |
+| `/arckit:dpia` | Data Protection Impact Assessment for the DPO |
+| `/arckit:tcop` | Technology Code of Practice compliance record |
+| `/arckit:risk` | Risk register snapshot for governance review |
+| `/arckit:principles-compliance` | Principles compliance evidence for architecture board |
+
+**Example** — compliance evidence pack from a Scottish Courts AI governance project:
+
+```text
+Read projects/014-scottish-courts/ARC-014-SECD-v1.0.md and
+projects/014-scottish-courts/ARC-014-DPIA-v1.0.md and
+projects/014-scottish-courts/ARC-014-TCOP-v1.0.md then use /pdf
+to create a combined compliance evidence PDF with
+"OFFICIAL-SENSITIVE" classification banner on every page.
+Save to exports/ARC-014-compliance-evidence.pdf
+```
+
+---
+
+### DOCX (`/docx`)
+
+Create editable Word documents for governance boards that mark up and comment on submissions.
+
+| ArcKit Command | Why DOCX |
+|----------------|----------|
+| `/arckit:sobc` | Strategic Outline Business Case for board approval |
+| `/arckit:sow` | Statement of Work for procurement negotiation |
+| `/arckit:requirements` | Requirements specification for stakeholder review |
+| `/arckit:strategy` | Strategy document for executive circulation |
+| `/arckit:stakeholders` | Stakeholder analysis for project initiation |
+
+**Example** — board submission from a Windows 11 deployment project:
+
+```text
+Read projects/003-windows11/ARC-003-SOBC-v1.0.md then use /docx
+to create a Word document with Document Control table on page 1,
+executive summary on page 2, and all sections following.
+Add "DRAFT — For Board Review" watermark.
+Save to exports/ARC-003-SOBC-board-submission.docx
+```
+
+---
+
+### PPTX (`/pptx`)
+
+Create slide decks for steering committees, show-and-tells, and stakeholder briefings.
+
+| ArcKit Command | Why PPTX |
+|----------------|----------|
+| `/arckit:presentation` | Architecture overview already structured for slides |
+| `/arckit:stakeholders` | Stakeholder map and power/interest grid for kick-off |
+| `/arckit:roadmap` | Technology roadmap for steering committee |
+| `/arckit:plan` | Architecture plan milestones for project board |
+| `/arckit:sobc` | Executive summary slides from business case |
+
+**Example** — steering committee deck from a fuel price transparency project:
+
+```text
+Read projects/017-fuel-prices/ARC-017-PRES-v1.0.md then use /pptx
+to create a 12-slide deck with: title slide, problem statement,
+proposed architecture, key risks, roadmap, and next steps.
+Use dark blue title bars and white body text.
+Save to exports/ARC-017-steering-deck.pptx
+```
+
+---
+
+### XLSX (`/xlsx`)
+
+Create sortable, filterable spreadsheets for analysis workflows and tool imports.
+
+| ArcKit Command | Why XLSX |
+|----------------|----------|
+| `/arckit:evaluate` | Vendor evaluation matrix with weighted scores |
+| `/arckit:risk` | Risk register with likelihood/impact heatmap |
+| `/arckit:backlog` | User stories for Jira or Azure DevOps import |
+| `/arckit:finops` | Cost breakdown with pivot-ready data |
+| `/arckit:requirements` | Requirements table for traceability matrix |
+
+**Example** — vendor evaluation matrix from a Windows 11 deployment project:
+
+```text
+Read projects/003-windows11/ARC-003-EVAL-v1.0.md then use /xlsx
+to create a spreadsheet with: Sheet 1 "Scoring Matrix" with
+weighted scores and conditional formatting (green/amber/red),
+Sheet 2 "Raw Data" with all vendor responses.
+Save to exports/ARC-003-vendor-evaluation.xlsx
+```
+
+---
+
+## End-to-End Use Cases
+
+These scenarios show how ArcKit commands chain with document skills to produce complete deliverable packs. Each references a real ArcKit test repo.
+
+### 1. Architecture Board Submission
+
+**Scenario**: Windows 11 Intune migration needs board approval.
+
+| Step | Action |
+|------|--------|
+| 1 | `/arckit:stakeholders` — identify board members and their concerns |
+| 2 | `/arckit:risk` — assess migration risks |
+| 3 | `/arckit:sobc` — build the Strategic Outline Business Case |
+| 4 | `/docx` — convert SOBC to editable Word for board mark-up |
+| 5 | `/pptx` — create executive summary deck for the meeting |
+
+### 2. Vendor Procurement Pack
+
+**Scenario**: Windows 11 deployment vendor evaluation for procurement.
+
+| Step | Action |
+|------|--------|
+| 1 | `/arckit:sow` — define Statement of Work |
+| 2 | `/arckit:evaluate` — score vendor proposals |
+| 3 | `/xlsx` — export evaluation matrix as sortable spreadsheet |
+| 4 | `/pdf` — create sealed PDF of final scores for procurement audit |
+
+### 3. Stakeholder Briefing Deck
+
+**Scenario**: Fuel Price Transparency Service kick-off with BEIS stakeholders.
+
+| Step | Action |
+|------|--------|
+| 1 | `/arckit:stakeholders` — map stakeholders and their interests |
+| 2 | `/arckit:requirements` — capture high-level requirements |
+| 3 | `/pptx` — build briefing deck with stakeholder map and top requirements |
+
+### 4. Compliance Evidence Pack
+
+**Scenario**: Scottish Courts AI governance review requires sealed evidence.
+
+| Step | Action |
+|------|--------|
+| 1 | `/arckit:secure` — run security assessment |
+| 2 | `/arckit:tcop` — assess Technology Code of Practice compliance |
+| 3 | `/arckit:dpia` — complete Data Protection Impact Assessment |
+| 4 | `/pdf` — bundle all three into a sealed compliance PDF pack |
+
+### 5. Sprint Planning Handoff
+
+**Scenario**: Criminal Courts technology review backlog ready for development.
+
+| Step | Action |
+|------|--------|
+| 1 | `/arckit:backlog` — generate user stories from requirements |
+| 2 | `/xlsx` — export as spreadsheet for Jira or Azure DevOps CSV import |
+
+---
+
+## Audience-to-Format Mapping
+
+Use this table to pick the right export format for your audience.
+
+| Audience | Preferred Format | Skill | Typical Artifacts |
+|----------|-----------------|-------|-------------------|
+| Architecture board | Word (editable) | `/docx` | SOBC, strategy, requirements |
+| Steering committee | PowerPoint | `/pptx` | Presentation, roadmap, plan |
+| Procurement panel | Excel + PDF | `/xlsx` `/pdf` | Evaluation matrix, SOW, sealed scores |
+| Development team | Excel | `/xlsx` | Backlog, data model, requirements table |
+| Auditors / compliance | PDF (sealed) | `/pdf` | Security assessment, DPIA, TCoP |
+| Data Protection Officer | PDF | `/pdf` | DPIA, data model, privacy assessment |
+| Project sponsor | PowerPoint | `/pptx` | Executive summary, stakeholder briefing |
+| Finance / CFO | Excel | `/xlsx` | FinOps, cost model, business case numbers |
+
+---
+
+## Tips
+
+**Branding in prompts** — Include your organisation's colours, logo placement, and font preferences in the skill prompt. For UK Government documents, add the classification banner (e.g., "OFFICIAL-SENSITIVE") as a header on every page.
+
+**MARP vs `/pptx`** — ArcKit's `/arckit:presentation` command generates MARP Markdown for quick slide previews. Use `/pptx` when you need a polished PowerPoint file with custom formatting, animations, or corporate templates. Both approaches work — MARP for speed, `/pptx` for polish.
+
+**Keep exports outside `projects/`** — Save document skill output to an `exports/` folder at the repo root. The `projects/` directory is for ArcKit's versioned Markdown artifacts. Keeping exports separate avoids cluttering the artifact tree and makes `.gitignore` patterns simpler.
+
+**Re-export after updates** — When ArcKit auto-versions an artifact (e.g., `v1.0` to `v1.1`), re-run the document skill to keep exports in sync. The Markdown source is always the single source of truth.
+
+**Batch processing** — You can convert multiple artifacts in a single prompt. Ask Claude to read several files and produce one combined document, or create separate files in a batch.
+
+---
+
+## Related Guides
+
+- [Plugin Setup & MCP Servers](mcp-servers.md) — Installing ArcKit and configuring MCP servers
+- [Presentation Guide](presentation.md) — Creating MARP slide decks with `/arckit:presentation`
+- [Vendor Evaluation Guide](evaluate.md) — Scoring vendors with `/arckit:evaluate`
+- [Business Case Guide](sobc.md) — Building Strategic Outline Business Cases
+- [Backlog Guide](backlog.md) — Generating user stories for sprint planning
+- [Security Assessment Guide](secure.md) — Running security assessments
+- [DPIA Guide](dpia.md) — Data Protection Impact Assessments