一键导入
compliance-check
Evaluate an architecture artifact (ADR, HLD, LLD) against the vault's established architecture principles
用 Codex 或 Claude 帮你安装 复制这段 Prompt,粘贴到 Codex、Claude 或其他助手里,让它检查 Skill 页面并帮你完成安装。
菜单
Evaluate an architecture artifact (ADR, HLD, LLD) against the vault's established architecture principles
用 Codex 或 Claude 帮你安装 复制这段 Prompt,粘贴到 Codex、Claude 或其他助手里,让它检查 Skill 页面并帮你完成安装。
基于 SOC 职业分类
Generate C4 architecture diagrams from system notes
Create and edit Obsidian Canvas files for architecture visualization
Visualize system dependencies and relationships
Analyse architecture diagrams and flowcharts
Generate architecture diagrams using Python diagrams library
Batch populate summary fields using content analysis
| name | compliance-check |
| context | fork |
| description | Evaluate an architecture artifact (ADR, HLD, LLD) against the vault's established architecture principles |
| model | opus |
Evaluate any architecture artifact against the vault's established architecture principles. Produces a structured compliance assessment with per-principle scoring, evidence mapping, and actionable remediation steps.
/compliance-check <artifact title>
/compliance-check "ADR - SAP Data Product"
/compliance-check "HLD - Remote Vault Access Architecture"
/compliance-check "LLD - Vault Bot Message Processing"
ADR - *.md, HLD - *.md, or LLD - *.md file in the vault.| Type | Location | Naming Pattern |
|---|---|---|
| ADR | ADRs/ | ADR - *.md |
| HLD | Root | HLD - *.md |
| LLD | Root | LLD - *.md |
$ARGUMENTSADRs/ folderADR -, HLD -, LLD -), try all three locationstype -- to confirm it is an architecture artifactrelatedTo wiki-links from frontmattertags for domain context (e.g., domain/security, project/beta)project if specifiedstatus (draft, proposed, accepted, etc.)Principles are stored as Concept notes with conceptType: principle in frontmatter. There are two categories:
Concept - *.md files with conceptType: principleConcept - Beta Solution Architecture Principles that contain multiple numbered principles in the bodyThe graph index does not include conceptType in its indexed fields. Use Grep to find principle notes:
grep -rl "conceptType: principle" *.md Concept\ -\ *.md
Read each discovered principle note and extract:
statement frontmatter field or the first blockquote in the body)implications frontmatter field)domain frontmatter field)Some notes contain multiple principles as sections (e.g., Concept - Beta Solution Architecture Principles with AP01-AP07). Search for these:
grep -rl "conceptType: principle" Concept\ -\ *.md
For collection notes, extract each individual principle:
Not all principles apply to every artifact. Use domain matching:
domain/security, project/beta, technology/ai)domain field matches the artifact's domain tags, ORtags overlap with the artifact's tags, ORstatement/implications are relevant to the artifact's subject matterIf in doubt about applicability, include the principle and mark as NOT APPLICABLE in the output rather than silently excluding it.
For each applicable principle, assess the artifact against it using this rubric:
| Status | Criteria |
|---|---|
| COMPLIANT | The artifact explicitly addresses this principle. Specific evidence exists in the design, decision rationale, or implementation approach. |
| PARTIAL | The artifact partially addresses this principle. Some elements are present but gaps remain -- the principle is not fully satisfied. |
| NON-COMPLIANT | The artifact does not address this principle despite it being applicable. The design contradicts the principle, or a relevant concern is entirely absent. |
| NOT APPLICABLE | The principle does not apply to this artifact's scope, domain, or context. Justify why. |
How to assess:
Output the assessment directly to the console. Use the template below.
## Principles Compliance Assessment
**Target:** [[{artifact title}]]
**Artifact Type:** {ADR / HLD / LLD}
**Artifact Status:** {status from frontmatter}
**Date:** {today}
**Principles Evaluated:** {count of applicable principles}
**Principles Excluded (not applicable):** {count}
---
### Compliance Summary
| Metric | Count |
|--------|-------|
| **Compliant** | {n} / {total applicable} |
| **Partial** | {n} / {total applicable} |
| **Non-compliant** | {n} / {total applicable} |
| **Not applicable** | {n} / {total evaluated} |
---
### Detailed Assessment
| # | Principle | Source | Status | Evidence | Gap |
|---|-----------|--------|--------|----------|-----|
| 1 | {Principle Title} | [[{source note}]] | COMPLIANT | {where in the artifact this is addressed} | -- |
| 2 | {Principle Title} | [[{source note}]] | PARTIAL | {partially addressed here} | {what is missing} |
| 3 | {Principle Title} | [[{source note}]] | NON-COMPLIANT | -- | {what is missing and why it matters} |
| 4 | {Principle Title} | [[{source note}]] | NOT APPLICABLE | -- | {why this principle does not apply} |
---
### Compliance by Domain
| Domain | Compliant | Partial | Non-compliant | N/A |
|--------|-----------|---------|---------------|-----|
| {domain} | {n} | {n} | {n} | {n} |
---
### Recommended Actions
For each PARTIAL or NON-COMPLIANT principle, provide a specific, actionable remediation step:
1. **{Principle Title}** (PARTIAL)
- **Gap:** {what is missing}
- **Action:** {specific change to achieve compliance}
- **Priority:** {high / medium / low -- based on principle criticality}
2. **{Principle Title}** (NON-COMPLIANT)
- **Gap:** {what is missing and the risk of non-compliance}
- **Action:** {specific change to achieve compliance}
- **Priority:** {high / medium / low}
---
### Context
**Principles sources consulted:**
- [[{principle note 1}]] -- {n} principles
- [[{principle note 2}]] -- {n} principles
**Artifact domain tags:** {list of domain/project tags from the artifact}
**Artifact linked notes:** {list of relatedTo references}
---
*Compliance assessment generated by Claude Code /compliance-check skill. Evaluates document completeness against established principles -- does not assess implementation quality.*
/compliance-check "ADR - SAP Data Product"
Evaluates the ADR against all applicable principles -- likely including data governance, integration, and security principles.
/compliance-check "HLD - Remote Vault Access Architecture"
Evaluates the HLD against all applicable principles. For a remote access architecture, security principles (Zero Trust, encryption) and operational principles (observability, failure recovery) would be particularly relevant.
/compliance-check "HLD - SecureTransfer Azure Files to S3 Mirroring"
If the HLD is tagged with project/beta, the Beta Solution Architecture Principles (AP01-AP07) would be included alongside any universal principles.
conceptType: principle notes exist in the vault. Suggest creating principles using the /incubator skill or referencing industry frameworks/hld-review -- Full six-dimension HLD review (includes principle compliance as one dimension)/nfr-review -- Review against NFR requirements (complementary -- NFRs and principles serve different governance purposes)/adr -- Create new ADRs for design choices identified as gaps/impact-analysis -- Analyse the impact of changes to systems referenced in the artifactConcept - Beta Solution Architecture Principles -- Seven Beta SA principles with fitness functionsConcept - Beta Digital Team Principles -- Beta Digital Team Principles.claude/context/architecture.md -- Architecture governance context.claude/context/frontmatter-reference.md -- Frontmatter schemas for ADR, HLD, LLD