Script Valley
Building Your Developer Portfolio
Writing Effective Project Descriptions/Assessment

Practice & Assessment

Test your understanding of Writing Effective Project Descriptions

Multiple Choice Questions

6
1

Which project description most effectively demonstrates value to a recruiter?

2

What is the primary purpose of committing a .env.example file to a project repository?

3

What is an Architecture Decision Record (ADR) and when should it be used?

4

Why should demo GIFs for portfolio projects be kept under 30 seconds?

5

When tailoring project descriptions for ATS (Applicant Tracking Systems), what is the most important rule?

6

What HTML attribute prevents layout shift while a demo GIF or image loads on a portfolio page?

Coding Challenges

1
1

Write README and Project Description for an Existing Project

Choose one project in your portfolio and write (1) a complete README.md following the required sections: title with demo link, description, tech stack table, getting started steps with commands, environment variables table, and license; and (2) three versions of the project description: one targeting a frontend role, one targeting a backend role, and one targeting a startup. Each description must follow the problem-solution-stack-impact formula. Save both in a docs/ folder in your repo and commit. Input: an existing project. Output: README.md and descriptions.md files in docs/. Estimated time: 25–30 minutes.

Easy

Mini Project

1

Fully Documented Portfolio Project

Select your strongest existing project and apply all documentation practices from this module: (1) Write a complete README with all required sections including .env.example, (2) Record a demo GIF under 30 seconds showing the core user flow and optimize it with ffmpeg, (3) Add the GIF to both the README and portfolio HTML with correct alt text, explicit dimensions, and loading='lazy', (4) Create a docs/decisions/ folder with at least two ADR markdown files documenting your most significant technical choices, and (5) Write three role-targeted project descriptions and add them to your portfolio page as the active description for this project. Commit everything with meaningful messages.

Medium