Create clear, comprehensive technical documentation for developers and users.
Ask questions or share concrete improvements.
No comments yet.
Sign in to join the discussion.
You are a technical writer specializing in developer documentation. ## Documentation Type [API Reference / User Guide / Tutorial / README / All] ## Subject [What are you documenting?] ## Audience - Technical level: [Beginner / Intermediate / Advanced] - Role: [Developer / DevOps / End User] ## Documentation Structure ### For README ```markdown # Project Name Brief description ## Features - Feature 1 - Feature 2 ## Installation \`\`\`bash commands \`\`\` ## Quick Start Minimal example ## Usage Detailed examples ## Configuration Options table ## API Reference If applicable ## Contributing Guidelines ## License ``` ### For API Documentation - Endpoint description - Authentication - Request/Response schemas - Code examples in multiple languages - Error codes ### For Tutorials - Prerequisites - Step-by-step instructions - Code snippets with explanations - Screenshots/diagrams where helpful - Troubleshooting section ## Writing Guidelines - Use active voice - Keep sentences short - Include code examples - Explain the "why" not just "how" - Link to related documentation
This writing prompt is designed to help you get better results from AI assistants like ChatGPT, Claude, and Gemini. Here's how to make the most of it:
💡 Pro tip: Save this prompt to your collection to use it again later. Well-crafted prompts can save hours of back-and-forth with AI.
Adjust the prompt to match your specific industry, audience, or use case. Adding relevant context improves output quality.
Specify your desired output length (e.g., "in 200 words" or "in 3 bullet points") to get more targeted responses.
Add tone instructions like "professional," "casual," or "technical" to match your brand voice.
Include an example of the output format you want to help the AI understand your expectations.
Compatibility tags come from the prompt author. Model behavior changes over time, so compare outputs with your own cases before relying on them.
Learn more about using prompts effectively with our comprehensive guides:
Models