Menu
Technical documentation best practices. Use for writing READMEs, API docs, code comments, and project documentation.
Install with Codex or Claude Copy this prompt, paste it into Codex, Claude, or another assistant, and let it review the skill page and install it for you.
Based on SOC occupation classification
RESTful API design best practices. Use when designing endpoints, request/response schemas, error handling, and API versioning.
Perform thorough code reviews with security, performance, and quality checks. Use when reviewing PRs, auditing code changes, or finding potential bugs.
Database design and optimization. Use for schema design, queries, migrations, indexing, and performance tuning.
Systematic debugging methodology for finding and fixing bugs. Use when investigating issues, tracing errors, or fixing production problems.
Docker and containerization best practices. Use for Dockerfile creation, docker-compose, multi-stage builds, and container optimization.
Git and GitHub workflow best practices. Use for commits, branches, PRs, merging, and version control operations.
| name | documentation |
| description | Technical documentation best practices. Use for writing READMEs, API docs, code comments, and project documentation. |
Write clear, maintainable technical documentation.
# Project Name
Brief description of what this project does.
## Features
- Feature 1
- Feature 2
## Quick Start
\`\`\`bash
# Install
npm install
# Run
npm start
\`\`\`
## Configuration
| Variable | Description | Default |
|----------|-------------|---------|
| `API_URL` | API endpoint | `http://localhost:8080` |
## API Reference
See [API Documentation](./docs/api.md)
## Contributing
See [CONTRIBUTING.md](./CONTRIBUTING.md)
## License
MIT
// calculateRateLimit returns the rate limit for a user based on their tier.
// Premium users get 1000 req/min, free users get 100 req/min.
func calculateRateLimit(tier UserTier) int {
// ...
}
/**
* Fetches user data from the API with automatic retry.
* @param userId - The unique identifier of the user
* @param options - Optional configuration
* @returns The user object or null if not found
* @throws {NetworkError} When the API is unreachable
*/
async function fetchUser(userId: string, options?: FetchOptions): Promise<User | null> {
// ...
}
// ❌ Obvious comments
i++ // increment i
// ❌ Outdated comments
// Returns user by email <- but function uses ID now
func GetUserByID(id string) *User