Manager-First READMEs
Published:
Manager-first READMEs
Restructured the READMEs across all 10 project repos today. The pattern: move the equations and implementation details into a “Technical Approach” section, and lead with what the project does, why it matters, and what it achieves.
This mirrors what we did with the portfolio entries — the same shift from developer-first to manager-first narrative. The README of a research project should still be technical, but the first thing someone reads shouldn’t be a Hamiltonian energy function. It should be: “This system detects geotechnical risk patterns in underground mines with >80% accuracy, enabling proactive safety decisions.”
The equations are still there. They’re just not the opening act anymore.
1. What it does (1-2 sentences)
2. Why it matters (business/research context)
3. Key results (KPIs or metrics)
4. Quick start (how to run)
5. Technical approach (equations, algorithms, architecture)
Same code, same science, different first impression. The developer who reads it gets everything they need. The manager who reads it understands the value before deciding whether to read further.
