sync-architecture-docs
Aligns project documentation with actual code changes including flows, states, and architectural dependencies.
Install
mkdir -p .claude/skills/sync-architecture-docs && curl -L -o skill.zip "https://agentskills.codes/api/skills/download/15243" && unzip -o skill.zip -d .claude/skills/sync-architecture-docs && rm skill.zipInstalls to .claude/skills/sync-architecture-docs
Activation
This is the description your AI agent reads to decide when to run this skill — the better it matches your request, the more reliably it fires.
Update and align project documentation after code or architecture changes. Use when modifying flows, states, modules, dependencies, contracts, or file structure in SignalEA_v1.Key capabilities
- →Collect changed files and identify architecture-impacting changes
- →Update architecture documentation for contracts and runtime flow
- →Update documentation for state model and ownership
- →Update documentation for dependencies and module boundaries
- →Verify consistency between documentation and source code
How it works
This skill collects changed files, identifies architecture-impacting modifications, and updates ARCHITECTURE.md and README.md to reflect changes in contracts, runtime flow, state models, and module dependencies. It verifies consistency.
Inputs & outputs
When to use sync-architecture-docs
- →Update docs after flow changes
- →Document state model modifications
- →Sync module dependencies
- →Verify documentation consistency
About this skill
Sync Architecture Docs
When to Use
- You changed execution flow (OnInit/OnTick/OnDeinit).
- You added or modified states, enums, structs, or class responsibilities.
- You changed module dependencies or folder structure.
- You introduced architectural placeholders or deferred implementations.
Primary Targets
Procedure
- Collect changed files and identify architecture-impacting changes only.
- Update architecture docs first:
- Contracts (enums/structs/interfaces)
- Runtime flow and sequencing
- State model and ownership
- Dependencies and module boundaries
- Keep docs implementation-neutral when logic is intentionally deferred.
- Add a short "Recent Architecture Changes" section with bullet points.
- Verify consistency:
- Names in docs match source names exactly.
- No references to non-existent files/classes.
- No claims of implemented trading logic if still placeholder.
- Run workspace diagnostics and confirm there are no new errors.
- Validate with Documentation Sync Checklist.
Output Format
- Modified files list.
- Short summary of what changed in docs.
- Any open follow-ups (if docs intentionally defer details).
Guardrails
- Do not implement trading logic while syncing docs.
- Do not invent modules not present in the codebase.
- Prefer concise, maintenance-friendly wording.
When not to use it
- →When implementing trading logic while syncing docs
- →When inventing modules not present in the codebase
Limitations
- →Do not implement trading logic while syncing docs
- →Do not invent modules not present in the codebase
- →Prefer concise, maintenance-friendly wording
How it compares
This skill automates the process of synchronizing documentation with code changes, ensuring accuracy and consistency more reliably than manual updates.
Compared to similar skills
sync-architecture-docs side by side with the closest alternatives in the catalog.
| Skill | Installs | Updated | Safety | Difficulty |
|---|---|---|---|---|
| sync-architecture-docs (this skill) | 0 | 2mo | No flags | Intermediate |
| deepwiki-rs | 25 | 9mo | Review | Intermediate |
| repo-research-analyst | 1 | 6mo | Review | Intermediate |
| c4-component | 1 | 4mo | No flags | Intermediate |
Try saying
Example prompts that trigger this skill in your AI assistant.
You might also like
deepwiki-rs
sopaco
AI-powered Rust documentation generation engine for comprehensive codebase analysis, C4 architecture diagrams, and automated technical documentation. Use when Claude needs to analyze source code, understand software architecture, generate technical specs, or create professional documentation from any programming language.
repo-research-analyst
parcadei
Analyze repository structure, patterns, conventions, and documentation for understanding a new codebase
c4-component
sickn33
Expert C4 Component-level documentation specialist. Synthesizes C4 Code-level documentation into Component-level architecture, defining component boundaries, interfaces, and relationships. Creates component diagrams and documentation. Use when synthesizing code-level documentation into logical components.
agent-pseudocode
ruvnet
Agent skill for pseudocode - invoke with $agent-pseudocode
spec
matteocervelli
>
cs-arch
wildlily1021
维护 `codestable/architecture/` 这份只记现状的系统地图，三种模式 update / check / backfill。触发：用户说"刷新 architecture"、"做架构检查"、"补这个模块的架构文档"、"方案和代码对得上吗"，或 feature 阶段需要先做架构动作。不写未来规划（走 cs-roadmap）。