this post was submitted on 21 Apr 2025
1140 points (99.6% liked)

Programmer Humor

22693 readers
1384 users here now

Welcome to Programmer Humor!

This is a place where you can post jokes, memes, humor, etc. related to programming!

For sharing awful code theres also Programming Horror.

Rules

founded 2 years ago
MODERATORS
 
you are viewing a single comment's thread
view the rest of the comments
[–] Alaknar@lemm.ee 2 points 12 hours ago* (last edited 12 hours ago)

How do you usually deal with that aspect? What I do is to make the documentation easily skimmable (for advanced readers) and just accept the need for rework.

Confluence's "Expand" element. Make everything into an easy to read task-list, but if more details are necessary, just expand a step and get an "idiot proof" description. Bookstack allows that as well, even better, because you can nest them (Confluence had that up until they "updated" the editor and killed half the features).

EDIT: "Include Page" in Confluence also works wonders here. For example, I have an article describing how to RDP to our AD server. In all articles that describe a process that needs to be done on the AD server, I just include that page. If any connection details change, I just edit the original article and the changes immediately propagate to all the other instances.