/arckit.customize

The /arckit.customize command copies ArcKit document templates to your project directory for customization. Your customizations are preserved when running arckit init again.

This is a slash command (not a CLI command). Run it from within your AI assistant.

Description

ArcKit uses document templates to generate consistent architecture artifacts. This command:

Copies default templates to .arckit/templates-custom/
Allows you to customize templates for your organization
Preserves customizations when running arckit init again
Supports copying individual templates or all 54 templates at once

Template locations:

Defaults: .arckit/templates/ (shipped with ArcKit, refreshed by arckit init)
User overrides: .arckit/templates-custom/ (your customizations, preserved across updates)

When a template exists in .arckit/templates-custom/, it takes precedence over the default template.

Usage

/arckit.customize [TEMPLATE_NAME]

Basic Examples

# List all available templates
/arckit.customize list
/arckit.customize

# Copy specific template
/arckit.customize requirements
/arckit.customize risk
/arckit.customize adr

# Copy multiple templates
/arckit.customize requirements risk adr

# Copy all templates
/arckit.customize all

# Show template info
/arckit.customize info requirements

Arguments

TEMPLATE_NAME

string

Template name(s) to copy. Use list to see all available templates, all to copy everything, or info <name> to see template details.Examples:

list - Show all available templates
requirements - Copy requirements template
risk - Copy risk register template
all - Copy all 54 templates
info requirements - Show what the requirements template contains

Available Templates

Template	Command	Description
`architecture-principles`	`/arckit.principles`	Enterprise architecture principles
`project-plan`	`/arckit.plan`	Project plan with timeline
`stakeholder-drivers`	`/arckit.stakeholders`	Stakeholder analysis
`architecture-strategy`	`/arckit.strategy`	Executive-level strategy document

Template	Command	Description
`requirements`	`/arckit.requirements`	Business & technical requirements
`data-model`	`/arckit.data-model`	Data model with GDPR compliance
`data-mesh-contract`	`/arckit.data-mesh-contract`	Data product contracts
`risk-register`	`/arckit.risk`	Risk register (Orange Book)

Template	Command	Description
`research-findings`	`/arckit.research`	Technology research findings
`aws-research`	`/arckit.aws-research`	AWS service research findings
`azure-research`	`/arckit.azure-research`	Azure service research findings
`datascout`	`/arckit.datascout`	External data source discovery
`platform-design`	`/arckit.platform-design`	Platform Design Toolkit
`wardley-map`	`/arckit.wardley`	Wardley Map documentation
`roadmap`	`/arckit.roadmap`	Architecture roadmap

Template	Command	Description
`sow`	`/arckit.sow`	Statement of Work / RFP
`dos-requirements`	`/arckit.dos`	Digital Outcomes & Specialists
`gcloud-requirements`	`/arckit.gcloud-search`	G-Cloud service requirements
`gcloud-clarify`	`/arckit.gcloud-clarify`	G-Cloud clarification questions
`evaluation-criteria`	`/arckit.evaluate`	Vendor evaluation framework
`vendor-scoring`	`/arckit.evaluate`	Vendor scoring matrix

Template	Command	Description
`architecture-diagram`	`/arckit.diagram`	Mermaid architecture diagrams
`adr`	`/arckit.adr`	Architecture Decision Records (MADR v4.0)
`hld-review`	`/arckit.hld-review`	High-level design review
`dld-review`	`/arckit.dld-review`	Detailed design review
`sobc`	`/arckit.sobc`	Strategic Outline Business Case

Template	Command	Description
`backlog`	`/arckit.backlog`	Product backlog with user stories
`servicenow-design`	`/arckit.servicenow`	ServiceNow service design
`devops`	`/arckit.devops`	DevOps strategy and CI/CD
`mlops`	`/arckit.mlops`	MLOps strategy
`finops`	`/arckit.finops`	FinOps cloud cost management
`operationalize`	`/arckit.operationalize`	Operational readiness pack
`traceability-matrix`	`/arckit.traceability`	Requirements traceability
`dpia`	`/arckit.dpia`	Data Protection Impact Assessment

Template	Command	Description
`analysis-report`	`/arckit.analyze`	Governance quality analysis report
`principles-compliance-assessment`	`/arckit.principles-compliance`	Principles compliance scorecard
`story`	`/arckit.story`	Project story with timeline
`service-assessment-prep`	`/arckit.service-assessment`	GDS Service Standard prep
`tcop-review`	`/arckit.tcop`	Technology Code of Practice
`ukgov-secure-by-design`	`/arckit.secure`	UK Gov Secure by Design

Template	Command	Description
`uk-gov-ai-playbook`	`/arckit.ai-playbook`	AI Playbook compliance
`uk-gov-atrs`	`/arckit.atrs`	Algorithmic Transparency Record
`mod-secure-by-design`	`/arckit.mod-secure`	MOD Secure by Design
`jsp-936`	`/arckit.jsp-936`	MOD AI assurance (JSP 936)

Template	Command	Description
`pages`	`/arckit.pages`	GitHub Pages site (HTML/CSS/JS)

What It Does

Reads Default Template

Loads the template from .arckit/templates/{name}-template.md

Updates Origin Banner

Changes template metadata:Before:

> **Template Origin**: Official | **ArcKit Version**: 0.11.5 | **Command**: `/arckit.requirements`

After:

> **Template Origin**: Custom | **Based On**: `/arckit.requirements` | **ArcKit Version**: 0.11.5

Writes to Custom Directory

Saves to .arckit/templates-custom/{name}-template.md

Command Uses Custom Template

When you run /arckit.requirements, it automatically checks:

Does .arckit/templates-custom/requirements-template.md exist?
If YES → Uses YOUR customized template
If NO → Uses default from .arckit/templates/

Common Customizations

Remove UK Government Sections

Use case: Non-UK Government projects What to change:

Delete “UK Government Alignment” sections
Remove TCoP, GDS Service Standard references
Change classification from “OFFICIAL-SENSITIVE” to your scheme

Example:

/arckit.customize requirements

Then edit .arckit/templates-custom/requirements-template.md:

- ## UK Government Alignment
- 
- This requirements specification aligns with:
- - [GDS Service Standard](https://www.gov.uk/service-manual/service-standard)
- - [Technology Code of Practice](https://www.gov.uk/guidance/the-technology-code-of-practice)
- - [NCSC Cloud Security Principles](https://www.ncsc.gov.uk/collection/cloud-security)

- **Classification**: OFFICIAL-SENSITIVE
+ **Classification**: INTERNAL

Change Document Control Fields

Use case: Add organization-specific fields What to change:

Add fields like Cost Centre, Programme, Portfolio
Remove fields not relevant to your organization
Change review cycle defaults

Example:

/arckit.customize requirements

Then edit .arckit/templates-custom/requirements-template.md:

| Document Type | Requirements Specification |
| Scope | [Project scope] |
| Review Date | [YYYY-MM-DD] |
+ | Cost Centre | [CC-XXXX] |
+ | Programme | [Programme Name] |
+ | Portfolio | [Portfolio Name] |
| Approver | [Name] |
| Distribution | [Distribution list] |

Modify Requirement Prefixes

Use case: Use your organization’s taxonomy What to change:

Change BR/FR/NFR to your organization’s prefixes
Update priority levels (MUST/SHOULD/MAY → P1/P2/P3)

Example:

/arckit.customize requirements

Then edit .arckit/templates-custom/requirements-template.md:

- **BR-001**: [Business requirement description]
- **Priority**: MUST
+ **BUS-001**: [Business requirement description]
+ **Priority**: P1 (Critical)

Add Organization Branding

Use case: Add logo, headers, footers, disclaimers Example:

/arckit.customize requirements

Then edit .arckit/templates-custom/requirements-template.md:

# Requirements Specification

+ ![Company Logo](../assets/logo.png)
+ 
+ **ACME Corporation**  
+ **Enterprise Architecture Practice**
+ 
+ ---

**Document ID**: ARC-{PROJECT_ID}-REQ-v{VERSION}

Customize Pages Template

Use case: Remove GOV.UK styling, add organization branding Example:

/arckit.customize pages

Then edit .arckit/templates-custom/pages-template.html:

- /* GOV.UK Design System Colors */
- --primary: #1d70b8;
- --header-bg: #0b0c0c;
+ /* Organization Colors */
+ --primary: #0066cc;
+ --header-bg: #003366;

- <h1>Architecture Documentation</h1>
- <p class="subtitle">UK Government Project</p>
+ <h1>Architecture Documentation</h1>
+ <p class="subtitle">ACME Corporation</p>

Keeping Templates Updated

When ArcKit CLI updates with new template features:

Default Templates Refreshed

Running arckit init refreshes .arckit/templates/ to the latest version

Customizations Preserved

Your customizations in .arckit/templates-custom/ are never modified

Compare and Adopt

Periodically compare your customizations with defaults:

# Read default template
/arckit.customize info requirements

# Compare with your custom template
# Then manually adopt new features you want

Reverting to Default

To stop using a custom template:

# Delete the custom template file
rm .arckit/templates-custom/requirements-template.md

The command will automatically use the default template next time.

Example Output

/arckit.customize list

Available Templates
-------------------

| Template | Command | Description |
|----------|---------|-------------|
| architecture-principles | /arckit.principles | Enterprise architecture principles |
| requirements | /arckit.requirements | Business & technical requirements |
| risk-register | /arckit.risk | Risk register (Orange Book) |
| sow | /arckit.sow | Statement of Work / RFP |
| adr | /arckit.adr | Architecture Decision Records (MADR v4.0) |
... (49 more)

Usage:
  /arckit.customize requirements      Copy requirements template
  /arckit.customize all               Copy all templates
  /arckit.customize info requirements Show template details

Troubleshooting

Template not found

Symptom:

Template 'xyz' not found. Run /arckit.customize list to see available templates.

Solution: Run /arckit.customize list to see exact template names:

/arckit.customize list

Custom template not being used

Symptom: Command still uses default template after customization.Cause: Template filename mismatch.Solution: Verify filename matches exactly:

# Should be:
.arckit/templates-custom/requirements-template.md

# NOT:
.arckit/templates-custom/requirements.md
.arckit/templates-custom/requirement-template.md

Want to reset customizations

Solution: Delete custom template and re-run command:

rm .arckit/templates-custom/requirements-template.md
/arckit.requirements

Or copy fresh default:

/arckit.customize requirements

arckit init

Initialize project and install default templates

/arckit.template-builder

Create new custom templates interactively

All Commands

See all 54 ArcKit commands

Overview

Foundation Commands

Analysis & Planning

Requirements & Data

Research & Strategy

Procurement Commands

Design & Architecture

Delivery & Operations

Compliance & Security

Quality & Reporting

Advanced Commands

/arckit.customize

/arckit.customize

Description

Usage

Basic Examples

Arguments

Available Templates

What It Does

Common Customizations

Remove UK Government Sections

Change Document Control Fields

Modify Requirement Prefixes

Add Organization Branding

Customize Pages Template

Keeping Templates Updated

Reverting to Default

Example Output

Troubleshooting

arckit init

/arckit.template-builder

All Commands

Build docs developers (and LLMs) love

Overview

Foundation Commands

Analysis & Planning

Requirements & Data

Research & Strategy

Procurement Commands

Design & Architecture

Delivery & Operations

Compliance & Security

Quality & Reporting

Advanced Commands

​/arckit.customize

​Description

​Usage

​Basic Examples

​Arguments

​Available Templates

​What It Does

​Common Customizations

​Remove UK Government Sections

​Change Document Control Fields

​Modify Requirement Prefixes

​Add Organization Branding

​Customize Pages Template

​Keeping Templates Updated

​Reverting to Default

​Example Output

​Troubleshooting

​Related Commands

arckit init

/arckit.template-builder

All Commands

Build docs developers (and LLMs) love

/arckit.customize

Description

Usage

Basic Examples

Arguments

Available Templates

What It Does

Common Customizations

Remove UK Government Sections

Change Document Control Fields

Modify Requirement Prefixes

Add Organization Branding

Customize Pages Template

Keeping Templates Updated

Reverting to Default

Example Output

Troubleshooting

Related Commands