ワンクリックで
architecture-audit
Comprehensive **project** consistency review across code, documentation, diagrams, and configuration
Codex または Claude でインストール この Prompt をコピーして Codex、Claude、または他のアシスタントに貼り付けると、Skill ページを確認してインストールできます。
メニュー
Comprehensive **project** consistency review across code, documentation, diagrams, and configuration
Codex または Claude でインストール この Prompt をコピーして Codex、Claude、または他のアシスタントに貼り付けると、Skill ページを確認してインストールできます。
SOC 職業分類に基づく
Focus blocks, distraction management, and flow state triggers for cognitively demanding work
Internal metacognitive skill for automatic capability discovery — self-triggers when uncertain about available skills
End-to-end academic paper drafting for CHI, HBR, journals, and conferences with venue-specific templates, drafting workflows, and revision strategies.
Patterns for thesis writing, dissertations, research papers, literature reviews, and scholarly work.
**Domain**: AI/ML Architecture
Domain knowledge for AI adoption measurement, psychometric instrument development, and appropriate reliance research
| name | Architecture Audit |
| description | Comprehensive **project** consistency review across code, documentation, diagrams, and configuration |
Comprehensive project consistency review across code, documentation, diagrams, and configuration
Systematic audit process to ensure all project artifacts stay synchronized. Catches version drift, terminology inconsistencies, outdated diagrams, broken references, and code-to-docs mismatches.
⚠️ IMPORTANT: This skill audits the user's project code, NOT the Alex cognitive architecture in .github/. Ignore .github/ folder contents when performing audits - focus on the actual source code, documentation, and configuration in the project root and subdirectories.
# Find version references in common locations
# EXCLUDE: .github/** (Alex cognitive architecture - not project code)
$patterns = @(
'package.json', # "version": "x.y.z"
'src/**/config*.json', # Version in config files (not .github)
'*.md', # Root documentation only
'docs/**/*.md', # Project docs (not .github)
'src/**/constants.ts', # Hardcoded versions
'CHANGELOG.md' # Version headers
)
# Grep for version patterns
Get-ChildItem -Recurse -Include $patterns |
Select-String -Pattern 'v?\d+\.\d+\.\d+' |
Group-Object -Property Line
Check: All version references match the canonical version (usually package.json)
Build a deprecated terms list for your project:
| Deprecated Term | Current Term | Migration Pattern |
|---|---|---|
DK-*.md | skills/*/SKILL.md | File format change |
domain-knowledge/ | skills/ | Folder rename |
| (project-specific) | (project-specific) | (document here) |
# Search for deprecated terms (exclude .github/)
$deprecated = @('OLD_TERM_1', 'OLD_TERM_2')
foreach ($term in $deprecated) {
Get-ChildItem -Recurse -Include "*.md","*.ts","*.json" -Exclude ".github" |
Where-Object { $_.FullName -notmatch '\\.github\\' } |
Select-String -Pattern $term
}
Maintain a facts file or section with current counts:
## Current Facts (Update on Audit)
- Skills: 46 folders
- Commands: 16 total
- Tools: 11 MCP tools
- Agents: 5 custom agents
- Instructions: 19 files
- Prompts: 7 files
Check: All documentation referencing these counts matches actual values
For each diagram (Mermaid/ASCII):
# Find all diagrams in project (exclude .github/)
Get-ChildItem -Recurse -Include "*.md" |
Where-Object { $_.FullName -notmatch '\\.github\\' } |
Select-String -Pattern '```mermaid|```ascii|┌|╔' |
Group-Object -Property Path
[text](path) → file exists)#section-name → heading exists)# Find markdown links in project (exclude .github/)
Get-ChildItem -Recurse -Include "*.md" |
Where-Object { $_.FullName -notmatch '\\.github\\' } |
Select-String -Pattern '\[.*?\]\((?!http)[^)]+\)' |
ForEach-Object {
# Extract path and verify existence
}
| Code Artifact | Documentation Location | Check |
|---|---|---|
| Exported functions | API docs | Signatures match |
| Config options | README/User Manual | All options documented |
| CLI commands | Help text / docs | Commands listed |
| Error messages | Troubleshooting | Errors explained |
# Architecture Audit Report
**Date:** YYYY-MM-DD
**Version Audited:** x.y.z
**Auditor:** [name/AI]
## Summary
| Category | Status | Issues Found |
|----------|--------|--------------|
| Version Consistency | ✅/⚠️/❌ | N |
| Terminology | ✅/⚠️/❌ | N |
| Fact Accuracy | ✅/⚠️/❌ | N |
| Diagrams | ✅/⚠️/❌ | N |
| Cross-References | ✅/⚠️/❌ | N |
| Code-Docs Sync | ✅/⚠️/❌ | N |
## Issues Found
### [Category]
- **File:** path/to/file
- **Line:** N
- **Issue:** Description
- **Fix:** Suggested correction
## Actions Taken
- [ ] Issue 1 fixed
- [ ] Issue 2 fixed
# .husky/pre-commit or similar
npm run audit:quick # Fast checks only
# GitHub Actions
- name: Architecture Audit
run: npm run audit:full
if: github.event_name == 'pull_request'
# Weekly full audit
on:
schedule:
- cron: '0 9 * * 1' # Monday 9am
❌ Skipping audits before release — Drift accumulates silently
❌ Manual-only audits — Automate what you can
❌ Fixing without documenting — Record the pattern for next time
❌ Ignoring "cosmetic" issues — They signal deeper drift
❌ Auditing only changed files — Drift affects unchanged files too
✅ Run full audit before major releases
✅ Add new deprecated terms as you migrate
✅ Update fact inventory after structural changes
✅ Document audit findings for patterns
✅ Automate repetitive checks
✅ Time-box manual review (don't boil the ocean)
release-preflight → Trigger audit before releasearchitecture-health → Synapse-specific validationcode-review → Audit as part of PR reviewrefactoring-patterns → Audit after major refactoring