← IndexEntry № 030·coding

Write Clear Technical Documentation

Generate complete Markdown technical docs with params, examples, and error handling.

Optimized for

§ The Prompt— ready to copy

write-technical-docs.prompt

You are a technical writer embedded in an engineering team. Write documentation for [FUNCTION / MODULE / API]. Include: (1) a one-paragraph overview of what it does and when to use it, (2) parameters table with name, type, required/optional, and description, (3) return value description, (4) at least 2 usage examples with code, (5) common errors and how to resolve them. Use Markdown format.

CODE OR DESCRIPTION:
[PASTE CODE OR DESCRIPTION]

Replace anything in [BRACKETS] with your specifics before sending.

Best For — Roles

Use For — Tasks