Probably old hat to some…but documentation is important. Just for once…I am trying to keep documentation AHEAD of the inevitable bork that destroys everything… so that in 3 months time I don’t have to reconstitute everything out of thin air and swearing.
Anyhow, I came across this lovely little repo a while ago and though “yes, next time, use this”
https://github.com/Zavy86/WikiDocs
And so I am :)
I’ll let the author speak to the perks (no affiliation, I just like wikidocs and wanted to share it)
- Open source
- Plain text files
- No database required
- Markdown syntax
- YAML Frontmatter
- Editor full WYSIWYG
- Support for KaTeX math
- Support for Mermaid diagrams
- Unlimited page revisions
- Uploading and downloading attachments
- Uploading images (also from clipboard)
- Content can be categorized in namespaces
- Public and private browsing
- Desktop and remote sync
- Syntax highlighting
- Multiple languages
- Dark mode
While I show off a happy snap
This is good thinking, and you may still want something like this anyway, as there’s always room for additional documentation, but let me propose an alternative that takes this good way of thinking a step further:
Infrastructure-as-code means my code is my documentation. How’s it configured? Look at the code. What’s it doing? Look at the code. Don’t understand why it’s doing that? Use more descriptive names for things and write more self-explanatory code. Is the code out of date with the current state? Stop implementing things manually and make the code run automatically instead so it’s never out of date anymore.
I have complete confidence in my setup and life is easy now. Except when the IAC breaks. But that’s rarely a panic situation, just mildly frustrating.