.claude/skills/document/SKILL.md
Generate or update project documentation. Use when asked to document code, create docs, explain features, or fix formatting, wording, or style in existing documentation files.
npx skillsauth add adobe/s3mock documentInstall this skill globally with one command. Works with Claude Code, Cursor, and Windsurf.
3 of 9 scanners reported clean
Some scanners were skipped, did not run, or reported a non-clean status. Review each row below.
Read AGENTS.md (root + relevant module) before making changes.
| File | Audience | Purpose |
|------|----------|---------|
| README.md | End users | Usage, configuration, operations table |
| CHANGELOG.md | End users | Version history, breaking changes |
| docs/TESTING.md | Contributors / AI agents | Testing strategy, base classes, patterns, commands |
| docs/KOTLIN.md | Contributors / AI agents | Kotlin idioms, naming conventions, anti-patterns, KDoc |
| docs/SPRING.md | Contributors / AI agents | Spring Boot patterns, DI, controllers, exception handling |
| docs/JAVA.md | Contributors / AI agents | Java idioms, naming conventions, anti-patterns, Javadoc |
| AGENTS.md (root + modules) | AI agents | Architecture, conventions, guardrails |
| .github/CONTRIBUTING.md | Contributors | Dev setup, code reviews |
New S3 operation: operations table in README.md (:x: → :white_check_mark:), CHANGELOG.md, server/AGENTS.md if new patterns introduced.
Configuration change: configuration table in README.md, configuration section in AGENTS.md, CHANGELOG.md.
Architecture change: relevant module's AGENTS.md, root AGENTS.md if cross-cutting, CHANGELOG.md.
Spring Boot pattern change: docs/SPRING.md, server/AGENTS.md if the change affects how controllers/services/stores are structured.
Kotlin/Java style change: docs/KOTLIN.md or docs/JAVA.md, root AGENTS.md DO/DON'T section if it introduces a new guardrail.
Group changes under the current version heading (e.g., ## 5.0.1). If that heading doesn't exist yet, add it under # CURRENT - 5.x - THIS VERSION IS UNDER ACTIVE DEVELOPMENT. Use clear user-facing language, note breaking changes explicitly, and reference GitHub issues/PRs where relevant. Follow the existing bullet structure: * Features and fixes, * Refactorings, * Version updates (deliverable dependencies), * Version updates (build dependencies).
Concise, active voice. Include runnable examples (Kotlin for API, shell for CLI). Link to AWS S3 API docs. Match existing formatting.
development
Write, update, or fix tests. Use when asked to test code, create test cases, or debug failing tests.
development
Review code changes in PRs or local diffs. Use when asked to review a PR, inspect changes, or provide feedback on code quality.
development
Fix code style issues and ensure linting passes. Use when asked to fix lint errors, formatting issues, or when ktlint or Checkstyle violations are reported.
development
Improve code readability, enforce idiomatic conventions, and enhance documentation quality. Use when asked to clean up code, improve naming, add meaningful comments, or align with Kotlin/project idioms.