architecture-doc-sync

Synchronize architecture documents with implementation changes and generate a traceability report.

Updated Mar 22, 2026
One-click install
npx skills add https://github.com/Burburton/amazing-specialists --skill architecture-doc-sync
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: architecture-doc-sync
Source: https://github.com/Burburton/amazing-specialists/tree/main/.opencode/skills/docs/architecture-doc-sync
Command: npx skills add https://github.com/Burburton/amazing-specialists --skill architecture-doc-sync

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Architecture documentation often drifts from the actual codebase, causing confusion and misalignment between design notes, ADRs, and implementation details. This skill ensures architecture documents stay synchronized with the current code by consuming upstream artifacts and generating an architecture-sync-report that captures evidence and changes.

Core Features & Use Cases

  • Consume design-note.md and implementation-summary.md to derive necessary updates and verify consistency across documents.
  • Update architecture documentation such as module boundaries, ADR statuses, and dependency graphs based on actual changes.
  • Produce architecture-sync-report with touched documents, consumed artifacts, and consistency checks to maintain traceability.

Quick Start

Run the architecture-doc-sync workflow to align design-note and implementation-summary based updates with the documentation.

Frequently Asked Questions about architecture-doc-sync

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

FAQPage Schema
How do I keep architecture documentation aligned with code changes?

To keep architecture documentation aligned with code, this skill consumes design notes and implementation summaries to update module boundaries, ADR statuses, and dependency graphs, preventing architectural drift.

What is architectural drift and how do I prevent it?

Architectural drift occurs when design notes, ADRs, and implementation details become misaligned with the codebase. You prevent it by synchronizing architecture documents using evidence-based updates from upstream artifacts.

How do I update ADRs and module boundaries based on implementation summaries?

You can update ADRs and module boundaries by running a synchronization workflow that consumes implementation summaries to verify consistency and apply necessary changes to architecture documentation.

Can I generate a traceable report for architecture synchronization?

Yes, you can generate an architecture-sync-report that captures touched documents, consumed artifacts, and consistency checks to maintain full traceability of architecture updates.

What is the best way to verify consistency across design notes and implementation summaries?

The best way to verify consistency is to consume both design-note and implementation-summary artifacts, derive necessary updates, and cross-check documentation against actual codebase changes.

Do I need specific design notes to start synchronizing architecture documents?

Yes, you need upstream artifacts like design-note.md and implementation-summary.md to drive evidence-based updates and ensure architecture documentation accurately reflects the current implementation.