3 ms·
Absolutely. I do those, as well. Here's a rather more intense example: https://riftvalleysoftware.com/work/open-source-projects/#baobab https://riftvalleysoftwa
by ChrisMarshallNY 5y ago
Absolutely. I do those, as well. Here's a rather more intense example: https://riftvalleysoftware.com/work/open-source-projects/#baobab https://riftvalleysoftware.com/work/open-source-projects/#ba...
I'm actually in the middle of using Postman to generate a more "modern" inline docset for a new engineer that is coming into a project that uses that server.
But I also like to keep docs to a bare minimum, as they become what I term "concrete galoshes": https://littlegreenviper.com/miscellany/concrete-galoshes/ https://littlegreenviper.com/miscellany/concrete-galoshes/
We need to be very careful, as the docs can prevent agility, in a big way.
I find that if I can keep the docs pinned to the code, itself, as much as possible, it helps to keep some flexibility.
- GordonS 5y agoAh nice, it's refreshing to see that level of documentation for an OSS project, even if it started as a commercial project. Totally agree about not having too much documentation - sometimes outdated documentations is worse than no documentation at all.