Write for the reader who has zero context from this conversation.
If it only makes sense to you right now, it will confuse someone else later.
References
references/readme.md — README structure, quick-start rules, what to document vs what not to
references/changelog.md — Keep a Changelog format with section types and examples
references/adr.md — Architecture Decision Record template and when to write one
references/openapi.md — OpenAPI spec minimum requirements per endpoint
See assets/templates.md for README skeleton, changelog entry, and ADR templates.
Checklist
- [ ] README updated if setup, config, or usage changed
- [ ] CHANGELOG entry added under [Unreleased]
- [ ] OpenAPI spec updated if any REST endpoint changed
- [ ] ADR written if a significant architectural decision was made
- [ ] Code examples in docs are verified to work
- [ ] No "TODO: document this" left behind
- [ ] Written for a reader with zero prior context
1---2name: thomiomi-agent-skills-documentation3description: Documentation4---56# Documentation78Write for the reader who has zero context from this conversation.9If it only makes sense to you right now, it will confuse someone else later.1011---1213## References1415- `references/readme.md` — README structure, quick-start rules, what to document vs what not to16- `references/changelog.md` — Keep a Changelog format with section types and examples17- `references/adr.md` — Architecture Decision Record template and when to write one18- `references/openapi.md` — OpenAPI spec minimum requirements per endpoint1920See `assets/templates.md` for README skeleton, changelog entry, and ADR templates.2122---2324## Checklist2526```27- [ ] README updated if setup, config, or usage changed28- [ ] CHANGELOG entry added under [Unreleased]29- [ ] OpenAPI spec updated if any REST endpoint changed30- [ ] ADR written if a significant architectural decision was made31- [ ] Code examples in docs are verified to work32- [ ] No "TODO: document this" left behind33- [ ] Written for a reader with zero prior context34```3536---37> Source: [thomiOmi/agent-skills](https://github.com/thomiOmi/agent-skills) — distributed by [TomeVault](https://tomevault.io).38<!-- tomevault:4.0:skill_md:2026-06-15 -->
Run npx skillmds@latest add tomevault-io/thomiomi-agent-skills-documentation in your terminal (requires Node.js), paste this page's agent-chat prompt into Claude, Cursor, or any MCP-connected agent, or download the SKILL.md file and copy it into your agent's skills directory.
Documentation It is listed under AI & ML on SkillMD.
This skill has not completed SkillMD's automated safety review yet. Independent scanners report: SkillSpector: PASS, Skill Scanner: PASS. SkillMD never runs a skill's scripts for you; review the SKILL.md before installing.
This skill is tagged as working with Claude Code, Claude.ai, OpenAI Codex. SKILL.md is an open format, so most agents that read a skills directory can load it too.
Yes. Installing skills from SkillMD is free, and the skill stays under its author's original license.
tomevault-io (@tomevault-io) published this skill. Their other Agent Skills are listed on their SkillMD profile.
tomevault-io