4 ms·
> Documenting the onboarding process I just want to add that this kind of documentation is worthwhile even for experienced developers. I've come across so man
by acuozzo 5y ago
> Documenting the onboarding process
I just want to add that this kind of documentation is worthwhile even for experienced developers.
I've come across so many projects in my career in which the hardest task of all is figuring out where to start looking at the code. The entrypoint is often non-obvious and starting at main() often fails to elucidate the narrative of the program.
To rectify this moving forward I've started keeping something of a development journal with new software I write. It's a cross between a README and a changelog and a sitemap; like printed MapQuest directions for my code.