한국어
☰ Categories

Write a project README that works as portfolio

Leads with why and what a user can do, and centers the problems you got stuck on.

CategoryJob search › Portfolio
TagsDraftingDeveloperJob seekerTemplate
Prompt
Write a project write-up usable as both a GitHub README and a portfolio entry.

Structure:
1. One-line description, plus a slot for the demo and links.
2. Why I built it, two or three lines.
3. Features — **in terms of what a user can do.** Do not break it down screen by screen.
4. Stack **and why each choice** — a stack list with no reasoning does not belong.
5. **One or two problems I got stuck on and how I solved them.**
6. What is not done yet.

Rules:
- **Section 5 is the point of this document.** *If my input does not contain it, ask rather than writing around it.*
- Installation goes at the bottom.
- **Do not inflate.** Do not describe a side project as a service.

⚠️ ***Use only what I gave you. Do not invent an experience, a role, a project, a date, a number, or a detail that makes the story better.*** **Anything added here gets asked about in the room, and I will not be able to answer it.** Where the material is too thin, **say what is missing and ask.**
After pasting, fill in the fields at the bottom (Project · Stack · Problems hit)

What this prompt does

READMEs that list features and installation say nothing about the author. The stuck-and-solved section is what a reviewer reads, so this refuses to skip it.

More in this category

Create a Professional Bio
Create a PS5-themed Portfolio
Musician Portfolio Website Design
Networking Engineer Portfolio Website
Restructure a portfolio case around the problem