Documentation Skill
Entry Criteria
Use when asked to update CHANGELOG.md, README.md, AGENTS.md (root or module), or docs/*.md, or to fix formatting/wording in any documentation file.
Execution Steps
Read root
AGENTS.mdand the relevant moduleAGENTS.md.Determine which file(s) to update by scenario:
Scenario Update New S3 operation README.mdoperations table,CHANGELOG.md,server/AGENTS.mdif new patterns were introducedNew API surface / port README.md(enablement, ports, config, ops table, Docker examples),CHANGELOG.md,server/AGENTS.mdConfiguration change README.mdconfiguration table, rootAGENTS.mdConfiguration section,CHANGELOG.mdArchitecture change Relevant module AGENTS.md, rootAGENTS.mdif cross-cutting,CHANGELOG.mdSpring Boot pattern change docs/SPRING.md,server/AGENTS.mdKotlin/Java style change docs/KOTLIN.md/docs/JAVA.md, rootAGENTS.mdDO/DON'T if a new guardrail is introducedFor
CHANGELOG.md: add under the current version heading (create it under# CURRENT - 5.x - THIS VERSION IS UNDER ACTIVE DEVELOPMENTif missing), matching the existingFeatures and fixes/Refactorings/Version updatesbullet structure. Use clear, user-facing language; note breaking changes explicitly; reference GitHub issues/PRs where relevant.Match surrounding style exactly (concise, active voice, runnable examples, links to AWS S3 API docs where relevant).
Verify technical accuracy against source code, and that all links and code examples are valid and runnable.
Completion Criteria
- All files for the scenario updated (see table above)
- Technical accuracy verified against source code
- Links and code examples are valid
- Matches surrounding style and formatting
Resources
AGENTS.mdand relevant moduleAGENTS.mdCHANGELOG.md,README.md— existing entries/tables to match