• Semi-Hemi-Lemmygod@lemmy.world
    link
    fedilink
    English
    arrow-up
    66
    arrow-down
    3
    ·
    5 months ago

    You have to assume some level of end user knowledge, otherwise every piece of documentation would start with “What a computer does” and “How to turn your computer on.”

    I’ve found the best practice is to list your assumptions at the top of the article with links to more detailed instructions.

    • Flax@feddit.ukOP
      link
      fedilink
      English
      arrow-up
      16
      ·
      5 months ago

      I do agree, manies have I found documentation saying “make a fresh install of Raspbian” as if I’m using the computer for this single issue

      (Disclaimer: I am not running matrix on a Raspberry Pi)

      • vividspecter@lemm.ee
        link
        fedilink
        English
        arrow-up
        6
        ·
        5 months ago

        Another case is listing a huge number of steps to do some task, without acting describing what the end goal for each set of instructions is (common in “how to” guides, and especially ones that involve a GUI).

        This means that less technical users don’t really understand what is going on and are just following steps in a rote way, and it wastes the time of technical users since they probably know how to achieve each goal already.