What did your onboarding documentation look like when you started your job?

Harriet - Mar 29 '20 - - Dev Community

I'd love to know what onboarding materials were provided to you when you started your job.

What does good documentation look like for getting started with a codebase? For getting started building features?

It's common to receive documentation around getting your dev environment set up, and the basics of building/running/testing/deploying the software you'll be working on.

But has anyone been provided with anything further? I'm imagining some "this is how we build stuff" documentation, detailing preferred patterns, or giving an introduction to the codebase, useful shared components, etc.

How about "this is how we work" documentation - i.e. who approves PRs, how to ask for review, how long is acceptable to wait, how work gets assigned, etc. Has anyone ever been issued useful documentation around process?

If so, I'd love to hear

  • What the project was (language, framework, basic function)

  • What general areas the documentation covered

  • How useful the documentation was

  • If you have been involved in maintaining the documentation, how you have found that.

. . . . . . .
Terabox Video Player