All guidesCareer

Write a README someone can actually follow

Good documentation helps a reviewer run your project and understand the decisions behind it.

Explain the purpose

Start with the problem, who the application serves, and the main flow. Include a screenshot or short demo with a link to the live application.

Make setup repeatable

List prerequisites, exact installation commands, required configuration names, and how to start the project. Provide an example environment file without real credentials.

Be concrete about evidence

Describe what you tested and the limitations you know about. Show an architectural decision with its tradeoff rather than a long list of technologies.

Explore a learning path