4 ms·
> The empathy part I don’t understand. This is what you need when writing documentation covering... 1. Where should someone new to the codebase start? Literal
by acuozzo 2y ago
> The empathy part I don’t understand.
This is what you need when writing documentation covering...
1. Where should someone new to the codebase start? Literally, which line in which file?
2. How does the code "fit together"? What is the call-graph of its top use-cases?
3. What are its compile-time and run-time dependencies? Which exact versions of those dependencies were used during development?
4. When something isn't working, how can someone replicate your development environment EXACTLY in order to determine what's different about theirs?
5. How would you approach debugging on this codebase? A detailed write-up or even a video of every step you took could help someone new gain a deep understanding quickly.
- janalsncm 2y agoYes, those are the main things I would also probably not remember in 6 months, and tend to write down in a readme.