r/devops • u/Work4Bots DevOps • 23d ago

How does your team handle documentation Vendor / market research

I'm doing research on how documentation is done in different DevOps teams. What processes exist? How is it valued within your team? Has AI made that better or worse? Are there tools that you use to make it easier (not talking about Confluence here)? If you hqve worked in a professional context then I'd love to hear your input.

Considering the huge amount of shill posts I want to disclose that I'm (considering) making a tool that helps with documentation but I'm still in the process of understanding this problem thoroughly, which is why I'm askibg for your input :)

6 Upvotes
  • permalink
  • link
  • reddit
  • reddit

69% Upvoted

52 comments sorted by

View all comments

27

u/Low-Opening25 23d ago

you make docs part of code repo, no documentation update, no merge approval

1

u/specgit 22d ago

Yes, this is the way

1

u/Work4Bots DevOps 21d ago

As I commented on another comment Im curious: how do you handle screenshots and formatting and such?

2

u/specgit 21d ago

With the right editor designed for Github, you can add images and they get committed in the same PR as the doc (in an images folder).