Documentation & Writing
Writing that helps other engineers understand, use and change your work.
Backend Engineer track
Junior
Write correct code, ship small changes safely, ask good questions.
Core: start here
- MarkdownThe plain-text formatting syntax used for READMEs, docs and PRs.
- READMEThe front page of a project: what it is, how to run it, how to contribute.
2 more junior concepts
- Docstrings / JSDocDocumenting functions and modules right next to the code.
- Technical WritingWriting clearly for other engineers.
Mid-level
Own a feature end to end without hand-holding.
- API DocumentationReference docs for an API's endpoints, parameters and errors.
- Architecture DiagramA box-and-arrow picture of a system's components and data flow.
- Class DiagramA diagram of classes, their fields and relationships.
- Diagrams as CodeWriting diagrams as text, with tools like Mermaid or PlantUML.
- Docs as CodeKeeping docs in the repository and reviewing them like code.
- Onboarding DocumentationDocs that get a new teammate productive quickly.
- RunbookStep-by-step instructions for operating or fixing a system.
- Sequence DiagramA diagram of messages passed between components over time.
- State DiagramA diagram of states and the transitions between them.
- UMLA standard visual language for software diagrams.
Senior
Own a system, its failure modes, and its trade-offs.
Core: start here
- Architecture Decision Record (ADR)A short document recording a decision, its context and its consequences.
- Design DocumentA written proposal of how to build something, reviewed before building it.
Staff
Shape how many teams build, across systems.
- RFCA request for comments: proposing a significant change for wide review.
Principal
Set technical direction for the organization.
Nothing here yet.
Data Analyst track
Junior
Write correct SQL, build trusted dashboards, ask good questions.
Mid-level
Own an analysis end to end, from vague question to recommendation.
- Design DocumentA written proposal of how to build something, reviewed before building it.
- Technical WritingWriting clearly for other engineers.
Senior
Own experimentation and metrics design; call out bad numbers.
Nothing here yet.
Staff
Shape how the organization measures and decides.
Nothing here yet.
Principal
Set measurement strategy across the company.
Nothing here yet.
Data Engineer track
Junior
Build and fix pipelines from clear specs; write correct SQL.
Core: start here
- MarkdownThe plain-text formatting syntax used for READMEs, docs and PRs.
- READMEThe front page of a project: what it is, how to run it, how to contribute.
2 more junior concepts
- Docstrings / JSDocDocumenting functions and modules right next to the code.
- Technical WritingWriting clearly for other engineers.
Mid-level
Own pipelines and models end to end, including their quality.
- API DocumentationReference docs for an API's endpoints, parameters and errors.
- Architecture DiagramA box-and-arrow picture of a system's components and data flow.
- Class DiagramA diagram of classes, their fields and relationships.
- Diagrams as CodeWriting diagrams as text, with tools like Mermaid or PlantUML.
- Docs as CodeKeeping docs in the repository and reviewing them like code.
- Onboarding DocumentationDocs that get a new teammate productive quickly.
- RunbookStep-by-step instructions for operating or fixing a system.
- Sequence DiagramA diagram of messages passed between components over time.
- State DiagramA diagram of states and the transitions between them.
- UMLA standard visual language for software diagrams.
Senior
Design the platform's storage, processing and modeling choices.
Core: start here
- Architecture Decision Record (ADR)A short document recording a decision, its context and its consequences.
- Design DocumentA written proposal of how to build something, reviewed before building it.
Staff
Shape how the whole organization produces and uses data.
- RFCA request for comments: proposing a significant change for wide review.
Principal
Set data strategy and architecture across the company.
Nothing here yet.
Frontend Engineer track
Junior
Build UI that works, ship small changes safely, ask good questions.
Core: start here
- MarkdownThe plain-text formatting syntax used for READMEs, docs and PRs.
- READMEThe front page of a project: what it is, how to run it, how to contribute.
2 more junior concepts
- Docstrings / JSDocDocumenting functions and modules right next to the code.
- Technical WritingWriting clearly for other engineers.
Mid-level
Own a feature end to end without hand-holding.
- API DocumentationReference docs for an API's endpoints, parameters and errors.
- Architecture DiagramA box-and-arrow picture of a system's components and data flow.
- Class DiagramA diagram of classes, their fields and relationships.
- Diagrams as CodeWriting diagrams as text, with tools like Mermaid or PlantUML.
- Docs as CodeKeeping docs in the repository and reviewing them like code.
- Onboarding DocumentationDocs that get a new teammate productive quickly.
- RunbookStep-by-step instructions for operating or fixing a system.
- Sequence DiagramA diagram of messages passed between components over time.
- State DiagramA diagram of states and the transitions between them.
- UMLA standard visual language for software diagrams.
Senior
Own an app's architecture, performance, and failure modes.
Core: start here
- Architecture Decision Record (ADR)A short document recording a decision, its context and its consequences.
- Design DocumentA written proposal of how to build something, reviewed before building it.
Staff
Shape how many teams build, across apps.
- RFCA request for comments: proposing a significant change for wide review.
Principal
Set technical direction for the organization.
Nothing here yet.