How To Create Quality Documentation (That People Will Use)Blog
Here’s the problem we need to address: many of the things IT teams do aren’t documented because they’re seen as busy work, there’s no time, people forget, or they just don’t want to. But here’s the thing: documentation may take some time, but it takes exponentially more time to research a solution every time you need it. For example, it might take 20–30 minutes to create a quality document. Researching a solution can take 10–15 minutes, and if you need to research it 2–3 times, that’s 20–45 minutes of research. Meanwhile, it only takes about 5 minutes to re-read a well-written document. So, let’s get started on how to do this. It happens all the time: you figure out a solution or process, implement it, and move on to the next task on your never-shrinking to-do list. A few months later, you need to do the same thing again and must dig through scripts, tickets, blogs, Slack, or wherever you found the solution, trying to recreate it. It takes a lot of time, and you think, “I really should
