skills.rest
fabioc-aloha
fabioc-alohaCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

Architecture Audit

Audits project consistency across code, documentation, diagrams, and configuration files.

1|Updated Mar 5, 2026
Search Tags:#code review#consistency check#architecture audit#documentation review#pre-release#version drift#cross-reference validation
One-click install
npx skills add https://github.com/fabioc-aloha/AlexAgent --skill architecture-audit-fabioc-aloha
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: Architecture Audit
Source: https://github.com/fabioc-aloha/AlexAgent/tree/main/plugin/skills/architecture-audit
Command: npx skills add https://github.com/fabioc-aloha/AlexAgent --skill architecture-audit-fabioc-aloha

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Projects accumulate drift over time: version numbers diverge between package.json and docs, deprecated terminology lingers, diagrams show outdated counts, and cross-references break silently. This Skill provides a systematic audit process to catch these inconsistencies before they reach users. ## Core Features & Use Cases - Version and Terminology Checks: Grep-based scans find mismatched version references and deprecated terms across Markdown, TypeScript, and JSON files. - Diagram and Cross-Reference Validation: Verifies Mermaid/ASCII diagram labels, internal Markdown links, and image references against actual project state. - Structured Audit Report: Produces a categorized report template (version, terminology, facts, diagrams, references, code-docs sync) with issue locations and suggested fixes. - Use Case: Before a major release, run a full audit to confirm that README counts, CHANGELOG versions, API docs, and configuration schemas all match the actual codebase. ## Quick Start Ask the AI to run an architecture audit on this project and report any version, terminology, or documentation inconsistencies.

Frequently Asked Questions about Architecture Audit

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I check version consistency across a project?▼

Search common version locations like package.json, config files, CHANGELOG.md, and constants files for semver patterns, then group results to find mismatches. All references should match the canonical version, typically defined in package.json.

How to find deprecated terminology in documentation?▼

Build a list of deprecated terms paired with their current replacements, then recursively search Markdown, TypeScript, and JSON files for each term. Document the migration pattern so new deprecated terms get added as the project evolves.

Can architecture audits be automated in CI pipelines?▼

Yes, quick checks can run as pre-commit hooks and full audits as GitHub Actions steps on pull requests. Scheduled weekly workflows using cron triggers catch drift that accumulates between releases.

What does a project consistency audit cover?▼

It covers version consistency, terminology drift, fact inventory accuracy, Mermaid and ASCII diagram validation, cross-reference resolution, code-to-docs synchronization, and configuration alignment. Findings are reported by category with file, line, issue, and suggested fix.

When should I run an architecture audit?▼

Run a full audit before major releases and after significant refactoring, since drift accumulates silently in unchanged files. Avoid auditing only changed files, and time-box manual review to keep the process sustainable.

Related Skills

Explore More Software Engineering Skills→
Ilenburg1993Ilenburg1993
3

documentation-governance

Audit and reorganize project documentation with updated indices and taxonomy.

Community
Advanced
SPANDigitalSPANDigital

release-pycel2sql

Automate version tagging, building, and publishing to PyPI for pycel2sql.

Official
Intermediate
wishx127wishx127

openspec-verify-change

Verify implementation completeness against change artifacts and source code evidence.

Community
Advanced
koki3141koki3141
2

verification-loop

Automate build, type checking, linting, testing, security scanning, and diff review.

Community
Intermediate