Code Documentation
Write clear inline documentation, JSDoc/docstrings, and module-level docs for your code
Template Fields
What Does the Code Do?multilineRequired
Describe the function, module, or codebase section to document. Paste code if helpful.
Programming LanguageselectRequired
TypeScriptJavaScriptPythonGoRustJavaC#RubyPHPSwift
Documentation TypeselectRequired
Function / method docs (JSDoc/docstring)Module / file headerREADME for a moduleInline comments for complex logicAPI type definitionsArchitecture overview
Documentation Audienceselect
Team membersOpen source contributorsAPI consumersFuture maintainers (including yourself)
Include Usage Examples?select
YesNo
Related Resources
Blog Post
5 Prompt Patterns for API Documentation and Integration
Copy-paste prompt templates for writing API docs, generating integration guides, troubleshooting endpoints, and creating SDK examples.
Blog Post
5 Prompt Patterns for AI-Assisted Code Review
Five prompt patterns for thorough AI code reviews. Covers security audits, performance checks, readability, bug detection, and architecture review.
Related Templates
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