Best ChatGPT Prompt for “Write a README”
ChatGPT responds best to Markdown-formatted prompts with role assignment, clear headers, and constraints placed at the end. It gives higher priority to end-positioned instructions, so placing your most critical requirements last produces significantly better results. This free template is optimized specifically for ChatGPT, achieving approximately 37% token reduction compared to unoptimized prompts while producing higher quality output.
Optimize Any Prompt Instantly
Stop manually formatting prompts for each AI model. PromptOptimizr auto-restructures your prompts for ChatGPT, Claude, Gemini, Cursor, and Claude Code — with 3 optimization styles.
What Most People Type
Optimized ChatGPT Prompt
# Task As an experienced technical writer specializing in open-source documentation, write a comprehensive README file for an open-source project. # Requirements * **Project Name:** [Insert Project Name Here] * **Description:** Briefly describe the project's core purpose and main features (2-3 sentences). * **Installation:** Provide clear, step-by-step instructions for installing the project. Include any prerequisites or dependencies. * **Usage:** Explain how to use the project with 2-3 practical examples. Cover common use cases. * **Contributing:** Outline the process for contributing to the project, including guidelines and code of conduct. * **License:** State the project's license. * **Badges:** Include placeholders for 3-5 relevant project badges (e.g., build status, license, version). * **Structure:** Organize the README logically with clear headings for each section. * **Clarity:** Use clear, concise language suitable for a diverse technical audience. * **Conciseness:** Aim for a README that is informative but not excessively long. # Output Format * A single Markdown file (`README.md`) containing all the sections outlined above. * Use Markdown formatting for headings, lists, code blocks, and links. * Ensure all instructions are actionable and easy to follow. * Critical constraints: Do not invent project-specific details; use placeholders where necessary.
Why This ChatGPT Prompt for “Write a README” Works Better
When you type “Write a README for my open source project” into ChatGPT, it lacks structure — ChatGPT has to guess what format you want, how detailed to go, and what to prioritize. The optimized version removes that guesswork.
It uses Markdown headers to organize the task, adds bounded constraints (specific numbers, word counts, formats), and places the most critical instructions at the end — where ChatGPT pays the most attention.
This Prompt Optimized for Other AI Models
Each AI model processes instructions differently. See how this same prompt is optimized for:
Frequently Asked Questions
What makes a good ChatGPT prompt for write a readme?
ChatGPT responds best to Markdown-formatted prompts with role assignment, clear headers, and constraints placed at the end. It gives higher priority to end-positioned instructions, so placing your most critical requirements last produces significantly better results.
Can I use this prompt template for free?
Yes — copy the optimized prompt below and paste it directly into ChatGPT. For unlimited prompt optimization across all 5 AI models, try PromptOptimizr free with 10 prompts per month. You can also use the Chrome extension to optimize prompts directly inside ChatGPT.
Why is this prompt different from a generic one?
Each AI model processes instructions differently. ChatGPT has specific formatting preferences — this prompt is structured to work with those preferences, not against them. The result is better output quality with approximately 37% fewer tokens.
More ChatGPT Prompt Templates
Optimize Prompts Without Leaving ChatGPT
The PromptOptimizr Chrome Extension injects directly into ChatGPT's interface. No tab switching — click the optimize button right inside the chat, pick your style, and get a model-specific prompt instantly. Works inside ChatGPT, Claude, and Gemini.
Get the Free Chrome Extension →