3 ms·
for documentation, I found it's helpful to think of what you're trying to accomplish theres a fantastic talk about the 4 types of documentation (https://www.ke
by kevinatac 6y ago
for documentation, I found it's helpful to think of what you're trying to accomplish
theres a fantastic talk about the 4 types of documentation (https://www.kevinslin.com/notes/89cefe18-cc6e-423e-8876-bc57b3821023.html https://www.kevinslin.com/notes/89cefe18-cc6e-423e-8876-bc57...) which i've listed below:
- tutorials
- how to guides
- explanations
- references
for internal software teams, I found explanation and references to be the most useful. in case you were also looking for a documentation tool, check out http://dendron.so http://dendron.so. its an open source note-taking tool build for developers and is integrated with vscode, markdown and git. plus it can compile to static html which you can host internally (disclaimer: I'm the founder)