living-documentation

Sync .kiro/specs requirements and design docs with code changes.

4|2|Updated Jan 16, 2026
One-click install
npx skills add https://github.com/PeterFile/my-common-skills --skill living-documentation
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: living-documentation
Source: https://github.com/PeterFile/my-common-skills/tree/main/living-documentation
Command: npx skills add https://github.com/PeterFile/my-common-skills --skill living-documentation

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill ensures living documentation stays aligned with the codebase by syncing spec files with code changes, reducing divergence between design docs and implementation.

Core Features & Use Cases

  • Auto-sync: Keeps .kiro/specs//requirements.md and .kiro/specs//design.md up to date with code changes.
  • Traceability: Embeds implementation notes and edge cases in specs to maintain a clear contract.
  • Collaborative workflow: Facilitates consistent updates when features are implemented, bugs fixed, or refactors occur.

Quick Start

Trigger the living-documentation skill after modifying code that affects .kiro/specs//requirements.md or .kiro/specs//design.md. Review the updated spec sections and commit them with the code changes.

Frequently Asked Questions about living-documentation

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

FAQPage Schema
How do I keep spec documentation in sync with code changes?

Spec documentation stays in sync with code changes by automatically updating .kiro/specs/*/requirements.md and design.md files to reflect feature implementations, bug fixes, and refactors, maintaining a clear contract between design and implementation.

What is living documentation and how does it maintain traceability?

Living documentation maintains traceability by embedding implementation notes and edge cases directly into spec files, ensuring the documentation evolves alongside the codebase rather than becoming stale.

When do I need to update .kiro/specs files during a refactor?

You need to update .kiro/specs files during a refactor when the changes affect behavior documented in requirements.md or design.md, and triggering the sync ensures the specs capture the new implementation logic and edge cases.

Does this documentation sync tool work with existing .kiro specs?

Yes, the documentation sync tool works directly with existing .kiro/specs/* directories, reading your current requirements.md and design.md files and applying updates based on the code modifications you have made.

What's the best way to document edge cases in living specs?

The best way to document edge cases in living specs is to enforce their inclusion during the code change sync process, embedding the edge case handling directly within the requirements and design documentation.

Why does spec documentation diverge from implementation over time?

Spec documentation diverges from implementation when code changes are made without updating the corresponding design docs, and living documentation solves this by syncing spec files with code changes to reduce divergence.