Technical Templates

Write a clear, actionable bug report that developers can act on immediately

Create a professional README.md for any project or repository

Document an API endpoint with request/response examples

Write clear, conventional commit messages with proper scope and description

Write clear, user-friendly changelogs and release notes from raw commit logs or feature lists

Write clear inline documentation, JSDoc/docstrings, and module-level docs for your code

Document environment variables with descriptions, defaults, validation rules, and examples

Document technical architecture decisions with context, options considered, and consequences

Create step-by-step incident response runbooks for common failure modes with escalation paths

Comprehensive API documentation with examples and best practices

Detailed system architecture and design documentation

Comprehensive code review template with best practices

Technical RFC document for proposing system changes

Detailed bug report with reproduction steps and analysis

Comprehensive migration documentation for system upgrades, platform changes, or technology transitions

Create comprehensive API tutorials with code examples

Generate comprehensive release notes for software versions

Create systematic troubleshooting guides for technical issues

Create comprehensive user guides and manuals

Create searchable knowledge base articles for self-service support

Document architectural decisions with context, consequences, and alternatives

Write clear, reviewable PR descriptions with context and testing notes

Write a blameless postmortem report for production incidents

Create a comprehensive onboarding document for new developers joining a team

Create an operational runbook for common procedures and incident response

Write a detailed technical spec for a new system or feature

Write standout GitHub profile READMEs and developer portfolio copy that showcases your work effectively

Design RESTful or GraphQL APIs with endpoints, schemas, auth, error handling, and pagination