[Category]

Example content

[Project name]

[One or two sentences: the problem, your role and the approach taken.]

This page uses placeholder content to show the case-study layout. It does not describe a real project.

Role: [Role]
Company: [Company]
Timeline: [Year]
Team: [Team size]
Stack: [Technology], [Technology], [Technology]

Contents

Overview

[Introduce the project in two or three sentences: what the product is, who uses it, and why the frontend work mattered.]

[Caption: what the screenshot shows and where it sits in the product.]

Context

[Describe the situation before the work started: the product stage, the existing frontend, and any organisational context that shaped the project. Keep confidential names and details out.]

Problem

[State the problem in one paragraph. Focus on the user or business problem first, then the technical one.]

My role

[Describe your role in one or two sentences, including what you owned end to end.]

[Responsibility you held]
[Responsibility you held]
[Responsibility you held]

Team

[Role]: [Number of people and what they owned]
[Role]: [Number of people and what they owned]

Technical requirements

Functional

[What the system had to do]
[What the system had to do]

Non-functional

[A constraint such as browser support, latency budget or offline behaviour]
[A constraint such as accessibility level or bundle-size limit]

Architecture

[Explain the architecture at the level a new team member would need on day one. Reference the diagram below.]

[System overview]

[Client]
- [App shell][Routing, auth]
- [Feature module] (highlighted)[The part this case study is about]
- [Feature module]
[Shared]
- [Design system]
- [State / data layer]
[Services]
- [API]
- [Real-time service]

[Caption: what the highlighted part is and why it matters.]

[Data flow]

[User action]
[Optimistic update][Where state changes]
[Queue / sync] (highlighted)
[Server confirmation]

[Caption: the path a single change takes through the system.]

Technology choices

[Technology]: [Why it was chosen over the alternatives]
[Technology]: [Why it was chosen over the alternatives]
[Technology]: [Why it was chosen over the alternatives]

Key decisions

[Decision title]

Context: [What forced a choice]
Decision: [What was decided]
Rationale: [Why, in terms of the requirements above]
Alternatives: [Option considered and why it lost]
[Option considered and why it lost]

[example-file].tsts

// Example only: replace with a short, non-confidential excerpt
// that makes the decision above concrete.
type SyncStatus = "idle" | "pending" | "failed";

export function nextStatus(current: SyncStatus, ok: boolean): SyncStatus {
  if (current === "pending") return ok ? "idle" : "failed";
  return current;
}

[Caption: what this excerpt shows.]

Trade-offs and challenges

[Trade-off title]

Gained: [What the team gained]
Cost: [What it cost]
Mitigation: [How the cost was contained]

[Challenge title]

Gained: [What was achieved despite it]
Cost: [What made it hard]

Performance and scalability

[Describe how performance and scale were approached: budgets, measurement, and the techniques used. Only include numbers you can verify.]

[Caption for a side-by-side comparison.]

Accessibility

[Describe accessibility work: keyboard support, screen-reader testing, contrast, motion. Name the standard you targeted.]

[Caption for a set of mobile screens.]

Lessons learned

[What you would repeat]
[What you would do differently]