What you'll learn: how to turn the capstone into a portfolio entry with a README and case study, report evaluation numbers honestly, check a repository before publishing, and write a LinkedIn headline and summary.
At a glance
Figure 1. The portfolio from repository to profile
How to read this: each box depends on the one before it, so nothing reaches your profile unchecked.
- A portfolio entry shows what you built, how you tested it and its limits.
- Evaluation numbers come from a run you can reproduce.
- A profile points to evidence; it does not replace it.
Scenario
Composite scenario, not a real company. A backend engineer finishes a small retrieval service for a fictional distributor and publishes it. The README says "AI-powered product assistant, production-ready, 98 percent accurate". A reviewer clones it and finds no tests running, a key committed in an example file, and no source for "98 percent". The numbers are illustrative and the scenario describes no real person.
What you will be able to do
- Structure a README and a case study for the capstone.
- Report evaluation results with counts, method and limits.
- Run a hygiene check before publishing.
- Write a headline and summary that link to evidence.
Prerequisites
Finish Positioning your enterprise experience. You also need a working capstone and its evaluation output (your 30/60/90 plan).
Core ideas
The README
| Section | What it must say |
|---|---|
| Problem | One paragraph, labelled fictional data and customer |
| What it does | Three bullets: inputs, outputs, refusals |
| Run it | Commands that work on a clean machine, without a key (the mock provider) |
| Test it | One command, and what a pass means |
| Evaluation | The table your run produced and the command that reproduces it (in the capstone, python -m eval.run_eval) |
| Limits | What it deliberately does not do |
The case study
A short page for a reader who will not clone the repository: problem, constraints, design (one diagram), what you measured, what failed, what you would change. "What failed" earns trust: name one error the evaluation caught and what you did.
At the customer: "How do I know your numbers are real?" Point to a command that regenerates them and a golden set the customer can read.
Reporting numbers honestly
Report counts with denominators ("5 of 6"), name the method (same questions, same scoring rule, which strategy) and say how small the sample is. Fictional data shows the method works, not that a real catalog would score the same.