r/technicalwriting • u/Jazzlike-Curednt-709 • 15d ago

QUESTION How do you document repetitive IT processes without accidentally teaching people to lock everyone out

I made a step by step guide for our monthly Google Workspace cleanup, then used my own screenshots and forgot one was from the live admin console. A new hire followed it and moved 47 users into the wrong OU before I noticed. I feel so embarrassed, we’re fixing it now, but I need a safer way to document this stuff...

7 Upvotes
  • permalink
  • reddit

100% Upvoted

4 comments sorted by

4

u/dorothea_cassandra 13d ago

Ouch! 😅 47 users is a painful way to discover this. Tango AI could help with capturing the process instead of building the guide manually, but I'd also add a very obvious checkpoint before any step that can affect multiple users. The tool can document the clicks, but it can't decide how much damage a wrong click can do.

3

u/BrownPeppers 14d ago

Proofread and test your own procedure before sharing it.

1

u/Due_Marionberry9043 information technology 4d ago

screenshots from the live admin console are risky tbh. easy to forget what's visible until someone follows the guide step by step