this post was submitted on 03 Dec 2025
34 points (100.0% liked)

Rant

525 readers
38 users here now

A place where you can rant to your heart's content.

Rules :
  1. Follow all of Lemmy code of conduct.
  2. Be respectful to others, even if they're the subject of your rant. Realize that you can be angry at someone without denigrating them.
  3. Keep it on Topic. Memes about ranting are allowed for now, but will be banned if they start to become more prevalent than actual rants.

founded 2 years ago
MODERATORS
 

I put a lot of work into writing up decent documentation and SOPs and making them available. Does anyone read them? Pfft, not if my work chat history is any indication. Constantly getting pinged for basic-ass questions I've already answered thoroughly when I wrote up the docs and SOPs.

And I'll go ahead and make sure you get another copy of that memo. Mm-Kay?

top 16 comments
sorted by: hot top controversial new old
[–] stoy@lemmy.zip 12 points 4 days ago

I feel your pain, and want to share two tips I have used that has worked well for internal documentation.

You may already do this, but just in case I thought I'd share.

  1. Use informal keywords at the bottom of the article. Especially rude ones. One monday when I came into the office I was met with a pissed off colleague, he wasn't angry with me, just the bad situation during the weekend, the server room (a purpose built server room) had had the AC fail during the weekend. So he had biked in and tried to fix it, there was a window that could be opened and we even had bought extra industrial fans, so we should be good right? Nope, they were stored in a locked room with a code lock next to the server room, we even had the code documented in the shared password manager, it was called something like "janitor's code" and he could not find it. I don't remember how he solved the situation, but seeing his frustration and irritation made me realize that we needed better keywords for the code. So I added stuff like "emergency code" and "general access code", but then I also added keywords like "fucking code", "idiot code", "damn door", "fucking door", "dickhead code" "just fucking get me in", "i give up" "fucking hell balls", stuff like that, it worked great, it was funny and made sure that everyone remembered how to get the code. Same goes with other documentation, pour your frustration into the keywords, lean into the office slang for best effect, I am Swedish and have used some rather creative compound words "nätverkshelvete", "skrivardjävel", "rövhålsjira" and "förbannade skithusswitch" are just some from the top of my head at this time.
  2. The second tip I can give you is to write every guide in two versions, one summary, assuming the reader knows their way around, and only really focusing on special actions like, "when creating a user with role X, make sure to set extensionAtribute24 to Y", and the other part is a full step by step part with highlighted screenshots for every step. This is something I tried and it did cut down on annoying people asking the same thing over and over.
[–] wesker@lemmy.sdf.org 11 points 4 days ago (3 children)

I wish it was professional to just reply with "RTFM" sometimes.

[–] owenfromcanada@lemmy.ca 15 points 4 days ago

I've responded with "check page 3 of the docs" before.

[–] hitmyspot@aussie.zone 4 points 4 days ago (1 children)

This is documented in the manual. Here is the solution. Can you please write a clearer entry, so the next person understands better, as you did not understand how I wrote it.

People are lazy. Make them do the work by asking and they will learn to do less work by checking the manual and not asking you.

[–] pdxfed@lemmy.world 3 points 3 days ago

This is fucking brilliant to ask for their input on how it should be written for "clarity". Suddenly "alles ist klar"

[–] ptz@dubvee.org 5 points 4 days ago* (last edited 4 days ago) (1 children)

Right?

On this last one, I did send the link to the documentation and copy/pasted the relevant bit from it in my reply.

Wonder if hyper-personalized pamphlets would be considered "professional"?

[–] Oisteink@lemmy.world 6 points 4 days ago (1 children)

So I could read it all, or just ask and you will provide the answer with links? Wonder what option to choose here

[–] lividweasel@lemmy.world 7 points 4 days ago

This. If you give them the answer, you’re just shooting yourself in the foot. The most you should do is direct them to the documentation. You need to train them to consult the documentation. If they ask you and you don’t immediately give them the answer, they’ll (slowly) learn not to bother asking you. The same goes for other things like getting them to put in a ticket. Hold firm, or the users will never learn.

[–] shalafi@lemmy.world 3 points 3 days ago

Sorry, I'm bad about this. Only way to beat it is to keep referring them to the docs. Be specific! "Check page 10 of the doc. Need that link again?"

[–] UnderpantsWeevil@lemmy.world 2 points 3 days ago

"The short answer is , but it can be complicated. Here's a link to my document. You can find the details on page ."

Been my response for a while. Occasionally, I ask if they've got the documentation site bookmarked or if there's anything in the documentation file that doesn't make sense. That tends to prod people in the right direction, and it also gets me helpful feedback when people complain that the document is unclear.

[–] NullCypher@lemmy.world 2 points 3 days ago

I started just linking to the documentation instead of answering the questions. Works most the time.

[–] JessyKenning@lemmy.world 2 points 4 days ago

"That's a stupid question"

[–] MelodiousFunk@slrpnk.net 3 points 4 days ago (1 children)

This is exactly why I stopped writing documentation.

[–] ptz@dubvee.org 3 points 4 days ago

I get the feeling, but documenting systems/processes and writing up SOPs for usage, maintenance, and operation is a required duty.

[–] Fleur_@aussie.zone 1 points 3 days ago

You would never hear about all the people who were helped out by your documentation and were able to get by without contacting you.

[–] HubertManne@piefed.social 2 points 4 days ago

I actually like discussing and going over stuff with people. Its more the boss and company not considering it efficient and accepting time will need to go to it.