Re:Ask HN: How do you organize software documentation at work?
by ragebol on Wednesday February 14, 2024 @10:26AM
(#39370902)
> Keeping things documented is part of the work, and if it isn't done, then the work is not completed.
Absolutely. Part of reviewing is checking that the eg. README is up to date and works as expected.
My response is almost "too bad". :) Keeping things documented is part of the work, and if it isn't done, then the work is not completed.
Your suggestions of (1) and (2) are great suggestions to have as components to the documentation system. Notebooks are really fantastic for this.