swe-documentation

Detect architecture-impacting changes and update ARCHITECTURE.md and ADRs.

1|1|Updated Mar 6, 2026
One-click install
npx skills add https://github.com/eymass/swe-plugin --skill swe-documentation
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: swe-documentation
Source: https://github.com/eymass/swe-plugin/tree/main/skills/swe-documentation
Command: npx skills add https://github.com/eymass/swe-plugin --skill swe-documentation

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Architecture documentation after code changes is kept current; it also triggers ADR creation for significant architectural decisions.

Core Features & Use Cases

  • Detect architecture-impacting changes after a dev task and update ARCHITECTURE.md.
  • Generate ADRs under docs/adr/ for significant decisions.
  • Enforce post-implementation governance to ensure documentation accuracy and traceability.

Quick Start

After finishing a development task, run the swe-documentation skill to audit architecture changes and update ARCHITECTURE.md and ADRs as needed.

Frequently Asked Questions about swe-documentation

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

FAQPage Schema
How do I keep architecture documentation up to date after code changes?

Updating architecture documentation after code changes involves detecting architecture-impacting modifications and applying them to ARCHITECTURE.md. This post-implementation process ensures documentation accurately reflects the latest service changes.

When should I create an Architecture Decision Record?

Create an ADR when a development task introduces significant architectural decisions. The post-implementation governance process triggers ADR generation under docs/adr/ to maintain decision traceability across services.

What is the best way to automate post-implementation documentation for software engineering tasks?

Automate post-implementation documentation by running a skill that audits architecture changes, modifies ARCHITECTURE.md, and generates ADRs. This enforces governance by recording only meaningful changes across services.

Do I need templates before generating architecture docs and ADRs?

Yes, up-to-date ARCHITECTURE.md and ADR templates must be present in your repository. The documentation process requires these templates to ensure accurate formatting and consistent governance across services.

How does post-implementation change detection work for architecture docs?

Post-implementation change detection analyzes finished development tasks to identify architecture-impacting changes across services. It updates architectural documentation and creates ADRs, ensuring only meaningful changes are recorded.

What are the limitations of automating ADR creation and architecture doc updates?

Automating ADR creation requires existing ARCHITECTURE.md and ADR templates to function. Additionally, the process records only meaningful changes, meaning minor code modifications might not trigger documentation updates.