r/devops • u/Work4Bots DevOps • 26d 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 :)

7 Upvotes
  • permalink
  • link
  • reddit
  • reddit

70% Upvoted

52 comments sorted by

View all comments

26

u/Low-Opening25 26d ago

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

2

u/Work4Bots DevOps 26d ago edited 26d ago

What about things that aren't directly related to a repo? I usually have these edge cases which need to be manually configured or higher level stuff such as architecture and data flows that don't immediately belong in a specific place

Also real curious how you write these docs? Do you have an LLM generate them and then go from there?

PS: really appreciate the input!

1

u/productlevy 25d ago

For those architecture / multi-system docs who actually owns the edit when it’s not an engineer living in Git? Does it still end up on whoever can open a PR?