3 ms·
Step 1: who is this documentation for? Non-technical users? Your colleagues and yourself when you come back to update it? Step 2: for technical docs, the close
by lazyasciiart 7y ago
Step 1: who is this documentation for? Non-technical users? Your colleagues and yourself when you come back to update it?
Step 2: for technical docs, the closer the docs are to the code, the more /likely/ it is to stay uptodate. What do you mean by "building a documentation system"?
- random_kris 7y agoI have a folder with markdown files where lots of stuff is documentated -> I call this documentation system. Stuff is accessed via search or menu (im using mkdocs) Documentation is for me and colleagues (looking up passwords, various links, urls, tutorials etc..)