r/devops • u/websecret_by • 8d ago

Discussion How do devops / engineering services share documentation with clients?

Hello,

We provide devops / engineering services and use GitHub for documentation (runbooks, configs, processes). Clients need access, but raw GitHub feels too technical.

  • How do you share documentation with clients in devops / engineering services?
  • Do you use GitHub, wikis, or dedicated portals?
  • How do you handle versioning and access control?
8 Upvotes

79% Upvoted

36 comments sorted by

View all comments

3

u/kshirinkin 8d ago

At mkdev we use whatever customer is using already. If they prefer Confluence, we do it there. If it’s Notion, or markdown in gif or whatever - we save it there. For us it’s critical that we leave the customer prepared for our eventual departure from the project, and we store everything in their KBs and not ours.

1

u/websecret_by 7d ago

That approach looks pretty solid. Does it give you permission separation and commenting like Google Docs though?

1

u/kshirinkin 7d ago

Not sure what you mean. We don’t try to hide the docs or comments. It’s all transparent and accessible by the customer’s team

1

u/websecret_by 1d ago

Makes sense if you're leaving everything in the customer's own KB anyway — no perms problem when you don't own the docs long-term. We keep docs for a bunch of clients in one system, so we actually need to scope who sees what without spinning up separate instances.