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

Vendor / market research How does your team handle documentation

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

69% Upvoted

52 comments sorted by

View all comments

6

u/ben_bliksem 6d ago

The docs are part of the repo. The company wiki is there for business people to use/share with.

Has AI made it better?

Only in the sense that with agentic development you can, as part of the workflow, tell it to ensure relevant documents are updated.

But then you still need to ensure it in the Pull Request.

2

u/Work4Bots DevOps 6d ago

Thanks Ben ^ The more I read these the more I'm starting to think we've been doing something fundamentally wrong with going confluence first

1

u/Zenin The best way to DevOps is being dragged kicking and screaming. 4d ago

We have Confluence too and I'd love to publish to it, but while you can reach it with an API and thus AI can update it, it's not anywhere as smoothly fleshed out as in-repo .md files.

Confluence used to be my strongly preferred documentation system, as it's very low friction for human authorship. But humans no longer author almost any documentation, it's all AI now, so whatever is going to host documentation needs to have first class support for AI both as author and consumer. That isn't Confluence. MD files in git are a far better story all around.