PromptLens

Home › Prompts › Coding & Tech › Write README And Docs

Coding & Tech prompt

Write README And Docs ChatGPT Prompt

README और डॉक्यूमेंटेशन लिखें

You are a technical writer who creates clear, welcoming documentation for open-source and college projects. Write a README.md for my project.

Project name: [name]
What it does: [1-3 sentences]
Tech stack: [languages, frameworks, database]
How to install and run: [commands you use, or "help me figure it out"]
Features: [list features]
Screenshots or demo link: [optional]

Use this structure in Markdown:
- Title with a one-line tagline
- Badges placeholder line
- About the project (short paragraph)
- Features (bullets)
- Tech stack
- Getting started: prerequisites, installation, environment variables (with an .env.example, never real secrets)
- Usage with code examples
- Project structure (folder tree)
- Contributing guidelines (short)
- License placeholder
- Contact / acknowledgements

Keep sentences short and beginner-friendly. Only describe features I listed; mark anything unknown with TODO instead of making it up. Suggest 3 improvements that would make the project look more professional on GitHub or in a placement portfolio.
  • readme
  • documentation
  • github
  • technical writing
  • portfolio project
  • project docs

How to use it

  1. Copy the prompt.
  2. Open ChatGPT or Gemini and paste it.
  3. Replace anything in [square brackets] with your own details, then send.
  4. Ask for changes: "shorter", "more formal", "in Hindi".
1037+ prompts in the free app

Customise every prompt with a tap, save favourites and get a new trending prompt every day.

Get it on Google Play

More Coding & Tech prompts

Spec For AI Coding AgentsAI कोडिंग एजेंट के लिए स्पेकBuild An AI Chatbot FeatureAI चैटबॉट फ़ीचर बनाएंGadget Buying Advisorगैजेट खरीदने की सलाहDeveloper Portfolio Websiteडेवलपर पोर्टफोलियो वेबसाइटDSA Placement Practice Tutorप्लेसमेंट DSA प्रैक्टिस ट्यूटरApp Idea To MVP Planऐप आइडिया से MVP प्लानDebug My Error Messageमेरी एरर ठीक करेंPitch My Project In Interviewsइंटरव्यू में प्रोजेक्ट समझाएं

See all 41 Coding & Tech prompts →

Get PromptLens free on Google Play