Onboarding guide
The wiki page that was last true in March
Your first week here
- Shape
- Follow one through
- Plates
- lede · steps · numbered · note
- Why
- Onboarding fails as a pile of links. Follow one person through the week and every part can say where they are and what they have already done. Keep `steps` — what the week does — apart from `numbered` — what *you* do. That distinction is the whole difference between a guide somebody follows and a page they skim and close.
Nobody expects you to ship anything this week. What we do expect is that by Friday you have run the thing locally and broken it once.
The shape of the week
Monday
Accounts, laptop, and lunch with whoever is around
Tuesday
Read the architecture note. Ask about the parts that seem mad
Wednesday
Run it locally. It will not work first time
Thursday
Fix one small thing somebody else wrote
Friday
Ship it, with a review from your buddy
- 1.
Ask your buddy, not the channel. For the first fortnight, everything goes to one person. It is their job this month and it is nobody's inconvenience.
- 2.
Write down what confused you. You will never see this codebase with fresh eyes again. Thursday's fix should be one of the things on that list.
- 3.
Break the local build on purpose. Knowing what a broken one looks like is worth more than a clean run you did not understand.
This is a sample. To author the same thing about your own subject, just name it. Your assistant can read this template, and will write you the same document about what you know.
Using the Ario tools, make me the "Onboarding guide"
template for a new designer's first week.
Show me the shape before you build anything.New here? How to connect one.
Other samples