this post was submitted on 02 Aug 2024
7 points (88.9% liked)

Selfhosted

53730 readers
504 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.

  7. No low-effort posts. This is subjective and will largely be determined by the community member reports.

Resources:

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

Questions? DM the mods!

founded 2 years ago
MODERATORS
 
top 12 comments
sorted by: hot top controversial new old
[–] ExcessShiv@lemmy.dbzer0.com 1 points 1 year ago* (last edited 1 year ago) (1 children)

Yeah the documentation (if it even exists) of most projects is usually clearly written by people intimately familiar with the project and then never reviewed to make sure it makes sense for people unfamiliar with it. But writing good detailed documentation is also really hard, especially for a specialist because many nontrivial things are trivial to them and they believe what they're writing is thorough and well explained even though it actually isn't.

[–] teft@lemmy.world 1 points 1 year ago (1 children)

This is why Technical Writer is a full time job.

[–] Semi_Hemi_Demigod@lemmy.world 0 points 1 year ago (1 children)

It's also why the humanities are important. Stemlords who brag about not doing literature classes write terrible documentation.

[–] HK65@sopuli.xyz 0 points 1 year ago (1 children)

Maybe, just maybe, people have different strengths and weaknesses and cooperating around our differences is what makes us succeed.

[–] Semi_Hemi_Demigod@lemmy.world 1 points 1 year ago (2 children)

If you know your weakness is writing documentation, please hire a technical writer.

[–] HK65@sopuli.xyz 1 points 1 year ago (1 children)

That's exactly what I'm saying, sorry if it came across somehow askew.

My point was there is no point in competing over whose job is "better", we should be working together.

[–] vividspecter@lemm.ee 1 points 1 year ago

There is a case to be made that people should be a bit more well rounded in general, and not just find a specific niche.

So non-technical people should still have a decent familiarity with computers and maybe be able to do some very basic coding. And technical people should spend some time working on their written and verbal communication.

Because in both cases, it makes people more effective in their roles.

[–] RobotToaster@mander.xyz 1 points 1 year ago* (last edited 1 year ago)

Most open source projects rely on volunteers, and few technical writers volunteer.

[–] Voroxpete@sh.itjust.works 0 points 1 year ago (1 children)

I write technical documentation and training materials as part of my job, and the state of most open source documentation makes me want to stab people with an ice pick.

[–] matzler@lemmy.ml 0 points 1 year ago

Do you have some reading recommendations on how to write good documentation, e.g. readmes for end users?

[–] AstralPath@lemmy.ca 0 points 1 year ago (1 children)

Honestly, as a newbie to Linux I think the ratio of well documented processes vs. "draw the rest of the fucking owl" is too damn high.

The rule seems to be that CLI familiarity is treated as though its self-evident. The exception is a ground-up documented process with no assumptions of end user knowledge.

If that could be resolved I think it would make the Linux desktop much more appealing to wider demographics.

That said, I'm proud to say that I've migrated my entire home studio over to linux and have not nuked my system yet. Yet... Fortunately I have backups set up.

[–] hactar42@lemmy.ml 1 points 1 year ago

Don't forget the situations where you find a good blog post or article that you can actually follow along until halfway through you get an error that the documentation doesn't address. So you do some research and find out that they updated the commands for one of the dependency apps, so you try to piece together the updated documents with the original post, until something else breaks and you just end up giving up out of frustration.