Hey everyone! I work at a Managed Service Provider and while we have some documentation on our environment and common issues, I want to create my own system for documentation. I find that not every issue needs to be documented in our existing framework, and I often see that my colleagues don't prioritize the quality of their tickets.
I want to put together a documentation tool that I can take with me to future jobs or use for troubleshooting at home. With my ADD, I sometimes forget what I've studied after taking breaks, so I'd also like to use this as a notes system to help me pick things up quicker.
Additionally, I want to capture the entire environment of our customers. While we don't manage everything for them, my broader knowledge often gives me more access to their systems. Jumping between different clients can make it tough to remember how each one is set up.
I'm looking for a software solution that addresses these needs. Right now, I'm keeping everything in .docx and .pdf formats, which makes it hard to find what I need. I'd love something that consolidates everything visually in one place. Here's what I'm looking for in a documentation tool:
* No monthly license fee; a one-time purchase is ideal (free options are a plus!)
* Ability to paste in pictures, logos, and scripts
* Categorization features
* Compatibility with iOS and wOS
I find Word and OneNote impractical, but if anyone has tips on effectively using them or alternative suggestions, please share! Thanks in advance!
6 Answers
Have you considered using Git with Markdown? It’s super flexible, and you can later repurpose your notes for different uses, like feeding into a custom GPT for easy access. This could really help organize your thoughts and scripts!
Another option to explore is using Markdown within a Git repository, along with a tool like mkdocs. This setup could really streamline your documentation process and keep everything organized. Here are some links for you to dive deeper: [Outline](https://www.getoutline.com/), [Bookstack](https://www.bookstackapp.com/), [MkDocs](https://squidfunk.github.io/mkdocs-material/).
I think you might benefit from using two types of platforms. One for quick notes, like Trilium or Evernote — those are great for screen captures and ad hoc records. Then another for more formal documentation. That way, you can keep quick thoughts and polished procedures separate!
I get that you find OneNote not practical, but believe it or not, many people in my organization swear by it for documentation. I personally use Word and then convert my stuff into a SharePoint page for sharing, though that comes with a fee. You might also want to check out Read the Docs; it’s a useful tool for documentation!
I think combining iOS compatibility with a free option can be tough, but I've heard good things about IT Glue being a solid tool for documentation in the industry. Maybe check that out!
If you're open to setting up a server, I'd recommend Bookstack. It's user-friendly and well-integrated. Plus, you can find more info at their site. Also, check out Outline Wiki for a fast and functional UI. Both could serve your needs well!
Related Questions
How to Build a Custom GPT Journalist That Posts Directly to WordPress
Fix Not Being Able To Add New Categories With Intuitive Category Checklist For Wordpress
Get Real User IP Without Installing Cloudflare Apache Module
How to Get Total Line Count In Visual Studio 2013 Without Addons
Install and Configure PhpMyAdmin on Centos 7
How To Setup PostfixAdmin With Dovecot and Postfix Virtual Mailbox