Skip to content

Operations · For your bots

Onboarding guide

Write an onboarding guide for someone new from the existing docs, repos and chat: day-one setup, who to ask, and a first real task.

In Lobstack: Skills › Library › Add

Download Lobstack

When to use it

Someone is joining a team, project or product, and what they need to know is scattered across docs, repos, chat and people's heads.

What your bot will do

  1. 01

    Ask who it is for — role and experience — and what they should be able to do by the end of week one. That goal decides what goes in.

  2. 02

    Read what exists: READMEs, the wiki, the handbook, recent chat about setup trouble. A setup question asked twice belongs in the guide.

  3. 03

    Write it in this order:

    • Day one: access to request and tools to install, with exact commands or links. Run each command if you can.
    • How things work here: the systems and terms they will hear first, one line each.
    • Who to ask: a table of topic and person or channel.
    • First task: one small, real piece of work with a clear finish line.
    • Week one: a checklist.
  4. 04

    Link to existing docs rather than copying them; copies go stale.

  5. 05

    Mark any step you could not verify "(unchecked)".

  6. 06

    End with the contradictions and gaps you found in the docs, for their owners.

  7. 07

    Post it as a document. Ask before sending it to the new person or adding it to a shared wiki.

The file

onboarding-guide/SKILL.md33 lines
---name: onboarding-guidedescription: "Write an onboarding guide for someone new from the existing docs, repos and chat: day-one setup, who to ask, and a first real task."metadata:  title: "Onboarding guide"  category: operations  tags: [onboarding, docs]--- ## When to use this Someone is joining a team, project or product, and what they need to know isscattered across docs, repos, chat and people's heads. ## How 1. Ask who it is for -- role and experience -- and what they should be able to   do by the end of week one. That goal decides what goes in.2. Read what exists: READMEs, the wiki, the handbook, recent chat about setup   trouble. A setup question asked twice belongs in the guide.3. Write it in this order:   - Day one: access to request and tools to install, with exact commands or     links. Run each command if you can.   - How things work here: the systems and terms they will hear first, one     line each.   - Who to ask: a table of topic and person or channel.   - First task: one small, real piece of work with a clear finish line.   - Week one: a checklist.4. Link to existing docs rather than copying them; copies go stale.5. Mark any step you could not verify "(unchecked)".6. End with the contradictions and gaps you found in the docs, for their owners.7. Post it as a document. Ask before sending it to the new person or adding it   to a shared wiki.

Get Lobstack.