789
submitted 3 months ago by Flax_vert@feddit.uk to c/selfhosted@lemmy.world
you are viewing a single comment's thread
view the rest of the comments
[-] Semi_Hemi_Demigod@lemmy.world 63 points 3 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_vert@feddit.uk 16 points 3 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 6 points 3 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.

this post was submitted on 02 Aug 2024
789 points (96.7% liked)

Selfhosted

39683 readers
540 users here now

A place to share alternatives to popular online services that can be self-hosted without giving up privacy or locking you into a service you don't control.

Rules:

  1. Be civil: we're here to support and learn from one another. Insults won't be tolerated. Flame wars are frowned upon.

  2. No spam posting.

  3. Posts have to be centered around self-hosting. There are other communities for discussing hardware or home computing. If it's not obvious why your post topic revolves around selfhosting, please include details to make it clear.

  4. Don't duplicate the full text of your blog or github here. Just post the link for folks to click.

  5. Submission headline should match the article title (don’t cherry-pick information from the title to fit your agenda).

  6. No trolling.

Resources:

Any issues on the community? Report it using the report flag.

Questions? DM the mods!

founded 1 year ago
MODERATORS