メニュー
This skill should be used when the user asks about "documentation", "README", "CHANGELOG", "CONTRIBUTING", "ADR", "architecture decision record", "changelog format", "keep a changelog", "doc comments", "API documentation", or needs guidance on project documentation requirements.
Codex または Claude でインストール この Prompt をコピーして Codex、Claude、または他のアシスタントに貼り付けると、Skill ページを確認してインストールできます。
SOC 職業分類に基づく
This skill should be used when the user asks about "AI development", "AI coding", "AI assistant", "CLAUDE.md", "AI context", "AI guidelines", "code generation", "AI workflow", "AI review", "AI configuration", or needs guidance on configuring AI assistants and AI-assisted development workflows.
This skill should be used when the user asks about "CI pipeline", "continuous integration", "GitHub Actions", "CI configuration", "CI jobs", "workflow", "CI caching", "CI environment", "pipeline structure", or needs guidance on setting up or configuring CI/CD pipelines.
This skill should be used when the user asks about "observability", "logging", "metrics", "tracing", "monitoring", "structured logging", "log format", "log levels", "distributed tracing", "OpenTelemetry", "health checks", or needs guidance on implementing observability and monitoring requirements.
This skill should be used when the user asks about "code quality", "formatting", "linting", "lint rules", "code style", "error handling", "unsafe code", "documentation comments", "doc comments", "rustfmt", "prettier", "eslint", "clippy", or needs guidance on code quality enforcement and configuration.
This skill should be used when the user asks about "release process", "versioning", "semantic versioning", "semver", "release automation", "publishing", "package publishing", "release checklist", "version bump", "release notes", or needs guidance on release workflows and version management.
This skill should be used when the user asks about "security", "vulnerability scanning", "dependency audit", "supply chain security", "license compliance", "security audit", "CVE", "OWASP", "secrets scanning", "cargo-deny", "npm audit", or needs guidance on security requirements and vulnerability management.
| name | docs |
| description | This skill should be used when the user asks about "documentation", "README", "CHANGELOG", "CONTRIBUTING", "ADR", "architecture decision record", "changelog format", "keep a changelog", "doc comments", "API documentation", or needs guidance on project documentation requirements. |
| version | 1.0.0 |
Guidance for implementing documentation requirements including project docs, changelogs, and Architecture Decision Records.
Available Tools: If using Claude Code, the
documentation-reviewplugin provides comprehensive documentation tools (/doc-review,/doc-create,/doc-update,/changelog). For ADRs, use theadrplugin (/adr:new,/adr:list,/adr:search).
| Document | Purpose |
|---|---|
README.md | Project overview, quick start, installation |
CONTRIBUTING.md | Contributor guidelines, setup instructions |
CHANGELOG.md | Version history and change documentation |
LICENSE | Software license terms |
SECURITY.md | Security policy and vulnerability reporting |
| Document | Purpose |
|---|---|
CODE_OF_CONDUCT.md | Community standards |
docs/architecture.md | System design and decisions |
| API documentation | Generated from code comments |
README MUST include:
README SHOULD include:
[](...)
[](...)
[](...)
[](...)
Changelogs MUST follow the Keep a Changelog format.
Each version entry MUST be organized into these categories:
| Category | Purpose |
|---|---|
| Added | New features |
| Changed | Changes to existing functionality |
| Deprecated | Features to be removed |
| Removed | Removed features |
| Fixed | Bug fixes |
| Security | Security-related changes |
Changelogs MUST include:
The [Unreleased] section MUST be maintained for ongoing changes.
# Changelog
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/),
and this project adheres to [Semantic Versioning](https://semver.org/).
## [Unreleased]
### Added
- New feature description
## [1.0.0] - 2024-01-15
### Added
- Initial release features
### Fixed
- Bug fix description
[Unreleased]: https://github.com/org/repo/compare/v1.0.0...HEAD
[1.0.0]: https://github.com/org/repo/releases/tag/v1.0.0
CONTRIBUTING.md MUST include:
CONTRIBUTING.md SHOULD include:
Significant technical decisions MUST be documented as ADRs.
ADRs MUST be stored in version control at docs/adrs/ (or docs/decisions/).
Each ADR MUST include:
| Section | Content |
|---|---|
| Title | Descriptive title with ADR number |
| Status | Proposed, Accepted, Deprecated, Superseded |
| Context | Background and problem statement |
| Decision | The chosen approach |
| Consequences | Positive and negative outcomes |
ADRs SHOULD also include:
ADRs MUST use a structured format such as:
ADR files MUST use consistent naming: adr_NNNN.md or NNNN-title.md.
Projects MUST maintain an ADR index/README listing all decisions.
# Verify required docs exist
ls README.md CONTRIBUTING.md CHANGELOG.md LICENSE SECURITY.md
# Check README has badges
grep -E "^\[!\[" README.md
# Verify changelog format
grep -E "^\## \[" CHANGELOG.md
# Check ADR directory
ls docs/adrs/ || ls docs/decisions/
references/readme-template.md - Complete README templatereferences/adr-template.md - MADR ADR templateexamples/CHANGELOG.md - Example changelogexamples/CONTRIBUTING.md - Example contributing guideexamples/adr-0001.md - Example ADR