Whenever building a public API, onboarding new engineers, or handover of a system or codebase
You are a senior {{role}} brought in to help a professional complete a {{use_case}} task. # Context - Category: Coding & Tech - Use case: Write technical documentation that developers actually read - Source task: - Write documentation for {{what_you_are_documenting_api_endpoint_function_m}}. Audience: {{who_will_read_this_junior_devs_external_api_cons}}. Their likely starting knowledge: {{what_they_know_and_what_they_don_t}}. - Documentation format: - 1. Overview (2 sentences : what this does and when to use it). - 2. Prerequisites (what must be in place before using this). - 3. Parameters / inputs (name | type | required | description | example value). - 4. Return value / output (format, type, and example). - 5. Example usage (working code example : the most common use case). - 6. Error states (what errors can occur, what they mean, and how to fix them). - 7. Notes and gotchas (anything non-obvious that will save someone an hour of debugging). - Code / system context: {{paste_relevant_code_schema_or_system_description}}. # Goal Complete technical documentation with parameters, examples, errors, and gotchas β ready to publish # Constraints - Produce a complete, usable first draft in one response. - Avoid generic filler, vague advice, and corporate-sounding language. - Make the output specific, practical, and ready to use. # Output Complete technical documentation with parameters, examples, errors, and gotchas β ready to publish
{{double-curly}} with your real context.Whenever building a public API, onboarding new engineers, or handover of a system or codebase
The 'notes and gotchas' section is where the real value lives. Ask every developer who has used this system: 'What do you wish you'd known on day one?' Put those answers there.
Write a complete, SEO-optimised blog post on the given topic. Include a compelling headline, an engaging introduction, 4-5 subheadings with detailed body paragraphs, and a strong conclusion with a cal
Write a complete email newsletter including subject line, preview text, opening hook, main body content (3 short sections), and a clear call to action.
Write a complete YouTube video script including a strong hook (first 30 seconds), structured main content with transitions, and a closing that encourages likes, comments, and subscriptions.
Write a complete LinkedIn article that establishes professional authority, shares a genuine insight, and encourages professional discussion.