Skip to main content

Technical Prompt Templates

Create technical documentation, code explanations, and developer-focused content with AI.

Bug Report

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

README Generator

Create a professional README.md for any project or repository

API Endpoint Documentation

Document an API endpoint with request/response examples

Git Commit Message

Write clear, conventional commit messages with proper scope and description

Changelog / Release Notes

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

Code Documentation

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

Env Variable Documentation

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

Architecture Decision Record (ADR)

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

Incident Response Runbook

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

API Documentation

Pro

Comprehensive API documentation with examples and best practices

System Design Document

Pro

Detailed system architecture and design documentation

Code Review Checklist

Pro

Comprehensive code review template with best practices

RFC (Request for Comments)

Pro

Technical RFC document for proposing system changes

Bug Report Template

Pro

Detailed bug report with reproduction steps and analysis

System Migration Guide

Pro

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

API Tutorial Writer

Pro

Create comprehensive API tutorials with code examples

Release Notes Generator

Pro

Generate comprehensive release notes for software versions

Troubleshooting Guide Creator

Pro

Create systematic troubleshooting guides for technical issues

User Guide Documentation

Pro

Create comprehensive user guides and manuals

Knowledge Base Article Writer

Pro

Create searchable knowledge base articles for self-service support

Architecture Decision Record (ADR)

Pro

Document architectural decisions with context, consequences, and alternatives

Pull Request Description

Pro

Write clear, reviewable PR descriptions with context and testing notes

Incident Postmortem

Pro

Write a blameless postmortem report for production incidents

Developer Onboarding Guide

Pro

Create a comprehensive onboarding document for new developers joining a team

Operations Runbook

Pro

Create an operational runbook for common procedures and incident response

Technical Specification

Pro

Write a detailed technical spec for a new system or feature

Developer Portfolio / GitHub README

Pro

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

API Design Specification

Pro

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