Enhanced Prompt

🎭 Role

Act as a Senior Technical Writer and Open-Source Maintainer with extensive experience in developer experience (DX) and technical documentation. You specialize in creating high-conversion, readable, and professional README.md files that improve project adoption and streamline contributor onboarding.

🌐 Context

I am preparing to launch an open-source project named [PROJECT_NAME]. The goal of this README is to serve as the primary landing page for the repository. It needs to be professional, intuitive, and structured in a way that minimizes friction for both users (who want to get started quickly) and contributors (who want to understand how to help).

Task

Draft a comprehensive and highly structured README.md file for this project based on the following specifications:

1. Header: Include the [PROJECT_TITLE], a placeholder for the logo, and a section for GitHub workflow badges (e.g., CI status, versioning, license, and deployment status).
2. Executive Summary: Write a compelling one-line elevator pitch, followed by a bulleted list of 3-5 core features or value propositions.
3. Visuals: Insert clear placeholders for a demonstration GIF or high-resolution screenshots that illustrate the project in action.
4. Onboarding: Create a "Getting Started" section including:
   • Prerequisites (software/environment requirements).
   • Step-by-step installation code blocks.
   • A minimal, "copy-paste-run" quick-start example.
5. Technical Documentation: Include an API reference or usage documentation section formatted for clarity.
6. Contribution & Community: Provide clear instructions on how to contribute, including links to CONTRIBUTING.md and the CODE_OF_CONDUCT.md.
7. Governance: Include a license section, credits/acknowledgments, and contact/support details.

⚖️ Constraints & Tone

• Tone: Professional, encouraging, technical, and concise. Avoid marketing fluff; focus on utility.
• Formatting: Use standard GitHub Flavored Markdown (GFM). Use callout blocks (e.g., > Note: or > Tip:) to highlight critical information.
• Structure: Keep paragraphs short and use headers to create a skimmable hierarchy.
• Avoid: Excessive jargon, wall-of-text sections, and outdated styling.

📝 Output Format

Provide the final output as a single, clean Markdown code block that I can copy directly into a README.md file. Include comments (using <!-- ... -->) within the Markdown to indicate where I should insert specific repository-specific links, images, or assets.

🧩 Variables

• Project Name: [PROJECT_NAME]
• Repository URL: [REPO_URL]
• Primary Programming Language: [LANGUAGE]
• Brief Project Goal: [DESCRIPTION]

How to use this:

1. Copy the block above.
2. Paste it into your AI tool (ChatGPT/Claude).
3. Fill in the Variables section at the bottom before hitting enter.