Comment on Ask HN: How do you organize software documentation at work?parentComments−bmitc2yI hate, hate software documentation as a concept. It gets out of date and is hard to use.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.−ragebol2yKeeping 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.
Comments
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.
Absolutely. Part of reviewing is checking that the eg. README is up to date and works as expected.