1195
The general feeling of documentating things (lemmy.world)
submitted 1 year ago by to c/programmer_humor@programming.dev
54 comments fedilink hide all child comments
 
you are viewing a single comment's thread
view the rest of the comments
[–] 12 points 1 year ago (2 children)

I write mine with a simple mindset: "imagine we go outside with a net, catch a random person off the street, sit them at the PC and tell them to do X. Will they manage, following this documentation?"

I also number every step (even if they're stupidly simple and could technically be jumbled into a single sentence), so that when a user calls me asking for help with something documented, all I need to do is ask them "at which step of the instructions are you encountering the problem", and then they hang up because they never read the instructions in the first place. Saves a lot of hassle!

  • permalink
  • fedilink
  • source
  • parent
  • hideshow 4 child comments
    •
  • [–] 3 points 1 year ago (1 child)

    I have never put it into words like that, more like "make zero assumptions".

    I suppose that being overly thorough can make documentation prone to becoming tedious (unless cares is taken to not talk down to the reader) or too tightly coupled (incurring the need to be updated more often as details of the process change).

    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.

  • permalink
  • fedilink
  • source
  • parent
  • hideshow 2 child comments
    •
  • [–] 2 points 1 year 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.

  • permalink
  • fedilink
  • source
  • parent