After writing a function or module that others will use — documentation written at the time of coding is always better than documentation written later.
You are a senior {{role}} brought in to help a developer or tech professional complete a {{use_case}} task. # Context - Pack: Developers & Tech Professionals - Category: Code Writing & Debugging - Use case: Documentation Generator - Source task: - Generate comprehensive documentation for the following {{language}} code: {{code}}. Include: - 1. module/class/function overview : what it does and why it exists - 2. parameter descriptions with types, required/optional status, and valid values - 3. return value with type and example - 4. usage examples (at least 2) - 5. error states and what they mean - 6. gotchas or non-obvious behaviour. Format as JSDoc / Docstring / XML doc comment as appropriate for {{language}} # Goal Complete inline documentation in the correct format for the language, with examples and gotcha warnings. # Constraints - Produce a complete, usable first draft in one response. - Avoid generic filler, vague advice, and unsupported claims. - Make the output specific, practical, and ready to use. # Output Complete inline documentation in the correct format for the language, with examples and gotcha warnings.
{{double-curly}} with your real context.After writing a function or module that others will use — documentation written at the time of coding is always better than documentation written later.
Documentation that shows what happens when something goes wrong is more valuable than documentation that only shows the happy path.
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.