Document
- 1 installs
- 1.1k repo stars
- Updated August 4, 2026
- adobe/s3mock
document is a Claude Code skill that generates and updates project documentation for the S3Mock repository.
About
document generates or updates project documentation for the S3Mock repository. It maps each kind of change (new S3 operation, configuration change, architecture change, style change) to the specific files that must be updated, from README and CHANGELOG to per-module AGENTS.md. A contributor uses it when documenting code, fixing docs, or updating the changelog.
- Generates and updates project documentation for the S3Mock codebase (README, CHANGELOG, AGENTS.md, module docs)
- Maps common change types (new S3 operation, config change, architecture change) to the docs that must be updated
- Enforces concise active-voice style with runnable Kotlin/shell examples and a verification checklist
Document by the numbers
- 1 all-time installs (skills.sh)
- Ranked #1,361 of 1,879 Documentation skills by installs in the Skillselion catalog
- Data as of Aug 5, 2026 (Skillselion catalog sync)
document capabilities & compatibility
- Capabilities
- documentation · changelog maintenance · technical writing
- Use cases
- documentation
What document says it does
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.
**New S3 operation**: operations table in `README.md` (`:x:` → `:white_check_mark:`), `CHANGELOG.md`, `server/AGENTS.md` if new patterns introduced.
Concise, active voice. Include runnable examples (Kotlin for API, shell for CLI).
npx skills add https://github.com/adobe/s3mock --skill documentAdd your badge
Show developers this skill is listed on Skillselion. Paste this into your README.
| Installs | 1 |
|---|---|
| repo stars | ★ 1.1k |
| Last updated | August 4, 2026 |
| Repository | adobe/s3mock ↗ |
What it does
Generate or update S3Mock project documentation (README, CHANGELOG, AGENTS.md) for a given code change.
Who is it for?
S3Mock contributors documenting a code change or updating the README, CHANGELOG, or AGENTS.md
Skip if: Documentation of unrelated projects or writing the S3Mock code itself
When should I use this skill?
Asked to document code, create docs, explain a feature, or fix wording and style in existing S3Mock docs
What you get
Updated, style-consistent S3Mock documentation with the correct files changed for the type of change
- Updated documentation files (README, CHANGELOG, AGENTS.md, module docs) matching existing style
By the numbers
- Documents 7 file audiences in the documentation-files table
- 4-item verification checklist before finishing
Files
Documentation Skill — S3Mock
Read AGENTS.md (root + relevant module) before making changes.
Documentation Files
| 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 |
What to Update
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.
CHANGELOG Format
Follow existing pattern: group under current version heading, clear user-facing language, note breaking changes, reference issues/PRs.
Style
Concise, active voice. Include runnable examples (Kotlin for API, shell for CLI). Link to AWS S3 API docs. Match existing formatting.
Checklist
- [ ] Verify technical accuracy against source code
- [ ] Ensure links and code examples are valid
- [ ] Match surrounding style and formatting
Related skills
Lark MarkdownInstantly turn any markdown file into clean, formatted Lark/Figma-compatible documents without manual reformatting.488k
Lark DocCreate, read, update, summarize, rewrite and manage Feishu/Lark cloud documents directly from agent workflows.401k16.1kLark WikiCreate, organize, query, and manage documents, spaces, and members inside Lark (Feishu) knowledge bases directly from AI agent workflows.397k16.1k
Domain ModelingBuild and sharpen a project's domain model: pin down domain terminology in a glossary and record architectural decisions as ADRs.318k202k
Opensource Guide CoachGet expert, attribution-safe guidance on launching and sustaining an open-source project.270k71Readme I18nMaintain consistent, updatable language selector blocks across every README variant in a multilingual repository.270k71