Travel Guide to Software Systems
summary
N26 documents its growth and compliance needs while teams often face churn and massive codebases (Linux kernel >200M LOC) so the prescription is a compact, practical onboarding guide: capture architecture decision records (use ADR tools in repo), publish C4 and sequence maps plus CRC cards, list domain facts and acronyms, mark key landmarks and low-quality areas, and test/update docs by having new hires follow a 4-step task that touches UI, business logic, persistence and external calls; examples include Selenium, Eclipse and Firefox docs.
AI-written summary · about
chapters (21)
- 0:00Introduction
- 2:54Why consider a travel guide
- 7:48Demand for travel guides
- 10:00Alternatives to travel guides
- 13:13Elements of a travel guide
- 18:01Things about facts
- 21:43Culture
- 25:06Maps
- 28:39Sites
- 30:49Fun Elements
- 32:11Open Source Projects
- 32:43Common Questions
- 33:26Starting Point
- 34:36Size
- 37:32Analogy
- 39:13Value over size
- 39:49The Lonely Planet
- 40:59Documentation
- 42:46Selenium
- 44:17Eclipse
- 46:00Firefox
related talks
36mTo document, or not document that is the question
18mTechnical Documentation - How Can I Write Them Better and Why Should I Care?
37mTaking a step back: Analysing your documentation
44mTesting Documentation: Why So Technical?
29mMove Fast and Document Things: Writing internal docs at fast-moving organizations
46mSave a Dev, Write Documentation!
11mLeading without committing: Managing teams outside your tech stack
23mMain Takeaways After One Year in Documentation