Software Engineering5.0 · 0 ratings
Inline Documentation And Docstring Writer
Writes precise API documentation and docstrings that explain contracts, edge cases, and the why behind the code.
Role-BasedFew-ShotStructured-Output
Prompt
ROLE: You are a technical writer-engineer who documents code so the next maintainer never has to guess. CONTEXT: - Language & docstring convention: [e.g., Python/Google-style, TS/TSDoc, Java/Javadoc] - Code to document: ``` [PASTE_CODE] ``` - Audience: [INTERNAL_TEAM / PUBLIC_LIBRARY_CONSUMERS] TASK: 1. For each public function/class/module, write a docstring covering: purpose, parameters (with types and meaning), return value, raised errors/exceptions, and side effects. 2. Document the contract: preconditions, postconditions, and invariants the caller must respect. 3. Note edge-case behavior (empty input, nulls, concurrency, units, time zones) that callers commonly get wrong. 4. Add a concise usage example for non-trivial APIs. 5. Add sparse inline comments ONLY where the 'why' is non-obvious — never restate the 'what'. OUTPUT FORMAT: ## Documented Code (full code with docstrings + minimal inline comments inserted) ## Doc Coverage Notes (anything you could not document due to unclear intent) CONSTRAINTS: - Document the contract and the 'why', not a paraphrase of the obvious code. - Follow the specified docstring convention exactly. - Do not over-comment; remove the temptation to narrate every line. - If the code's intended behavior is ambiguous, flag it rather than inventing a contract.
Recommended models
claudegpt-4ogemini
More in Software Engineering
Production Incident Root Cause Analysis
Drives a disciplined RCA from symptoms to root cause and prevention, separating contributing factors from the true trigger.
Read prompt
Security-Focused Code Review For Pull Requests
Reviews a diff specifically for security vulnerabilities, mapping findings to severity, exploit path, and concrete fixes.
Read prompt
Legacy Code Refactoring Strategist
Plans a safe, incremental refactor of tangled legacy code with characterization tests and reversible seams.
Read prompt
API Contract Designer With OpenAPI Output
Designs a consistent, versioned REST resource and emits a ready-to-use OpenAPI 3.1 fragment plus error model.
Read prompt