Practice writing and evaluating onboarding documentation for new engineers: setup guides, first-week plans, and knowledge transfer documents.
0 / 8 completed
1 / 8
What is the primary audience consideration when writing a developer onboarding guide?
Onboarding docs are written for someone with zero context about the specific codebase and team. Every implied step or unexplained term is a potential blocker for a new joiner.
2 / 8
Which element is most important to include in an environment setup guide?
Setup guides must be executable. Every step needs the exact command, and ideally shows what successful output looks like so the reader knows whether the step worked.
3 / 8
What does 'the 30-60-90 day plan' structure in onboarding documentation describe?
A 30-60-90 day plan sets expectations: 30 days = learning the codebase and process; 60 days = making small contributions; 90 days = owning a feature or area. It gives new joiners a clear ramp-up path.
4 / 8
How should you document a 'known issue' in a setup guide?
Known issues that new joiners hit repeatedly should be documented with symptoms, workarounds, and context. This saves hours of debugging time and shows the team is maintaining the docs.
5 / 8
What is 'evergreen documentation' in the context of onboarding?
Evergreen docs stay current. Teams often achieve this by linking docs to the code review process (docs updated when related code changes), assigning doc owners, or scheduling periodic reviews.
6 / 8
Which sentence best opens the 'Architecture Overview' section of an onboarding guide?
A good architecture overview names the components, explains what each does in one sentence, and describes how they relate. This gives a new joiner a mental model before diving into code.
7 / 8
What is the purpose of a 'Glossary' section in onboarding docs?
Every team uses internal shorthand — project codenames, abbreviations, service nicknames. A glossary prevents new joiners from being blocked by unfamiliar terms in meetings and documentation.
8 / 8
What does 'doc rot' refer to in documentation management?
Doc rot (documentation rot) is the decay of documentation accuracy over time. Outdated onboarding docs are particularly harmful because they waste new joiners' time and erode trust in documentation.