TGViewer
CatOps CatOps @catops · 5.07K subscribers
Post #2029 5.32K
​Good documentation is foundational for implementing DevOps capabilities - State of DevOps says.

But writing good docs is hard... and what can you do, except hire a Tech writer?
Cry Try to write docs better.

Here are free technical writing courses by Google (and quick recap). I drive "good docs culture" (that happened historically) in my current job and find these courses really helpful in describing to teammates how docs should look.

Also, I found that already exist documentation style guides by Google and Microsoft so you don't need entirely reinvent the wheel, just a little part of it ;)

On the other hand, these style guides look very complicated, so to not be overwhelmed, just start from these highlights.

And if you need, more technical writing resources and reasons why docs should be and should be good - here.

P.S. Don't repeat my mistake - take these courses before start writing and reviewing docs on a regular basis, not in ~2 years after.

#documentation #culture
  • 👍 13
  • ❤ 3
  • 👎 1
  • 🤔 1
More from @catops
  1. Oct 16, 2026Are you sure that it is a vacation, and not just location/activity change? Why I still see…
  2. Oct 16, 2026While I’m still enjoying my vacation, this CVE is too interesting to pass by. PwnEscape: G…
  3. Oct 8, 2026I’m going on a vacation, which means that I likely won’t post at all or post something ver…
  4. Oct 6, 2026A colleague of mine wrote an article about data migrations. Handling data migrations witho…
  5. Oct 1, 2026​​I traded my personal information for this report, so you don’t have to! DataDog presents…
  6. Sep 29, 2026A Cybersecurity books bundle by O’Reilly on Humble Bundle. The bundle is fresh and is stil…
Threads Profile ViewerView any public Threads profile without an account.Open ThreadLook →Writing with AI? Make it sound human.Metric37 rewrites AI drafts so they read naturally. Free AI detector, 1,500 words free.Try Metric37 →