3 ms·
Agreed with this evaluation of where we lost the plot in this thread. Documentation is both "javadoc" and "architecture diagrams and business reasons for what
by sanderjd 3y ago
Agreed with this evaluation of where we lost the plot in this thread.
Documentation is both "javadoc" and "architecture diagrams and business reasons for what to build and why at a high level". And it's also useful to have a level in between, in the repo, that is more higher level than class-and-method-level "javadoc", but more technical than business-level documentation.
What I was trying to say is that if you want developers to read the business level documentation, you need to link to it from the in-repo documentation that the developers are already reading in order to do their jobs.
No IC is going to navigate to the business-level documentation and just start reading. What would be the trigger to do this during the course of their day? No, they're going to follow a link from somewhere. You have to put links in the right places!
- deleted 3y ago[deleted]