README Architect Project Writer

This README writer template helps you turn a rough project description into a polished first impression for users and contributors. It prompts the model to cover the essentials, including what the project does, how to install it, how to run it, and how to contribute. The structure is simple enough for beginners, but flexible enough for production repos that need consistent onboarding information.

It is especially useful for solo developers, startup teams, and open-source maintainers who want a README that reduces support questions and improves adoption. The prompt encourages the model to highlight value, prerequisites, and example usage before diving into contribution guidelines or licensing notes. You can tailor the result for GitHub, GitLab, or internal documentation by adjusting the target audience and tone. When used consistently, it creates a standard format across multiple repositories, which makes project discovery much easier.

Customize the prompt by filling in {{PROJECT_NAME}}, {{PROJECT_SUMMARY}}, and {{INSTALL_STEPS}}. Add {{FEATURES}}, {{USAGE_EXAMPLE}}, and {{CONTRIBUTING_GUIDELINES}} if you want a more complete repository page. The output should be a clean README with headings, short paragraphs, and code blocks where helpful. For best results, include the intended audience in {{AUDIENCE}} so the model can choose the right level of detail and terminology.