Skip to content

What do you use for documentation that actually gets read?

General Discussion by Bruno22 26 replies 3.2K views
#21
haroldgsm said:
Test them twice a year or they lie to you

This. We do "fire drill" Friday, pick random runbook, follow it exactly, fix what is wrong. Found three broken links last month. The team hates it until it saves them at 3am.

swimming upstream since 2019 🐟
4 #22

I try make error message like angry forum post now ạ very direct, "your config wrong here, fix or I stop" ạ users actually read and reply to bot with thank you ạ

6 #23

Has anyone tried Obsidian for team docs? The graph view is nice but I worry about sync conflicts with multiple people.

2 #24

Obsidian sync is paid per user and the git plugin is clunky. We tried, went back to markdown in repo. Your IDE already shows you the graph if you use links.

#25

Following this thread. We are stuck on Confluence and I need ammunition to move.

5 #26
king7 said:
Following this thread. We are stuck on Confluence and I need ammunition to move.

Show them the search. Search Confluence for something you know exists, time it, then search the same term in repo with grep. The difference is your ammunition.

swimming upstream since 2019 🐟
#27

I do the grep test today, 12 seconds vs 4 minutes. My boss is convinced now, we move next sprint. Thank you all!

ping so high I wave back

Post a reply

You need an account to reply. Log in or register to join the conversation.

Post reply Preview Save draft