906
Never again (lemmy.world)
top 50 comments
sorted by: hot top controversial new old
[-] IdiosyncraticIdiot@sh.itjust.works 111 points 9 months ago

Imagine being in a corporate environment trying to implement an OSS into your platform and having to tell your 50 yo teammate: "Oh yeah, just pop in this Discord server real quick to see any relevant info". Instant credibility loss

[-] evatronic@lemm.ee 124 points 9 months ago

The loss of credibility is not because it's discord,. specifically.

It's because the project thinks a chat platform is an appropriate way to document a project. I would feel the same way if someone told me to get on IRC for docs, or Slack.

[-] 5714@lemmy.dbzer0.com 11 points 9 months ago

Matrix for example would be better.

[-] eatham@aussie.zone 68 points 9 months ago

Nope, should be on a forum or wiki or normal doc

[-] wewbull@feddit.uk 21 points 9 months ago

Not even a forum.

Documentation is not a snapshot of a discussion. It largely falls into two categories

  • collections of facts e.g. what command line switches there are, or all the options in the config files.
  • Guides on how to use the software.

The first is vital. The second is really really useful.

[-] barsoap@lemm.ee 4 points 9 months ago

Actually the first should be the latter, not in the sense that there shouldn't be a list of switches, a list of options somewhere, or no terse sum-up docs for all those little things, but that those sum-up docs should be the header to a guide.

I may be getting old but I think earlier UNIX had that, and we kinda lost it: Back when programs had few switches the man page would have a header explaining the command tersely -- "foo grobnitzes flobboxes" or such, two or three options described equally terse, then you'd get into usage and examples. Nowadays, where GNU less lists its options as

less [-[+]aABcCdeEfFgGiIJKLmMnNqQrRsSuUVwWX~]
            [-b space] [-h lines] [-j line] [-k keyfile]
            [-{oO} logfile] [-p pattern] [-P prompt] [-t tag]
            [-T tagsfile] [-x tab,...] [-y lines] [-[z] lines]
            [-# shift] [+[+]cmd] [--] [filename]...

, note the fucking alphabet in the beginning, it's pages upon pages of terse technical definitions in the rest of the manpage. (Yeah I know less probably doesn't need extensive usage docs it's pretty self-evident but my point stands).

We have hypertext now. This can contain a gazillion links to this. And please no no gnuinfo I still don't know how to navigate that thing, I barely know how to exit it. Lynx and w3m prove that it's possible to do intuitive design with links in the terminal, do better. Me wanting to quickly look stuff up is not the right time to insist I learn your awkward pet documentation interface, Richard.

[-] 5714@lemmy.dbzer0.com 9 points 9 months ago

In comparison to discord, but true.

[-] pingveno@lemmy.ml 4 points 9 months ago

Wikis always seem to produce second rate documentation, except maybe the ones that are designed specifically around software projects. There are any number of tools out there that produce better documentation and it can be stored alongside the source code in a git repository to avoid drift between the code and the associated documentation.

[-] eatham@aussie.zone 21 points 9 months ago

They are only second rate if not used.

load more comments (1 replies)
[-] pastermil@sh.itjust.works 7 points 9 months ago

Might as well be a telegram group chat.

[-] pancakes@sh.itjust.works 50 points 9 months ago
[-] MonkCanatella@sh.itjust.works 47 points 9 months ago

I've literally never seen a project remotely interesting that has their documentation on discord

[-] marcos@lemmy.world 20 points 9 months ago

To be fair, I could say the same, but is probably a biased sample.

I have other red flags, like only distributing on docker, that I've tried, and tried again, and found that it's a sign of a badly run project. But I can't state any confidence on the discord based rule, because I've never tried to make any run.

[-] wewbull@feddit.uk 14 points 9 months ago

The docker thing really grinds my gears. I see it as the ultimate "works on my machine" mentality. Basically they can't be arsed to write software that is robust to changes in hosting platform.

[-] mb_@lemm.ee 3 points 9 months ago

I have dealt with "only works in kubernetes" because developers couldn't be bothered to make it even work on docker without all the hidden orchestration.

So, instead of documentation, they just make the service work in that one specific environment.

[-] redcalcium@lemmy.institute 20 points 9 months ago

Revanced was one. Good thing they wisen up and have documentations now, though it's just a set of .md files in their git repo.

[-] theherk@lemmy.world 26 points 9 months ago

Markdown in the repository is a pretty good way to keep documentation in sync with the source.

[-] jackpot@lemmy.ml 2 points 9 months ago
[-] JPSound@lemmy.world 5 points 9 months ago

Modded version of youtube app that let's you kill all the ads, among many other wonderful features. However, every 6 months or so, youtube does something where the videos stop loading effectively killing the app. I usually switch between vanced and revanced every 6 or so months because one has so far always worked when the other gets the axe. By the time that one goes down, the other one is back up and running.

[-] thejevans@lemmy.ml 2 points 9 months ago

The Gagguino project is a counterpoint to this. They have some extremely limited documentation, but to really build one you probably are going to need to dig into Discord. I hate it. The project is really cool, though, and I'm building one right now.

[-] Omega_Haxors@lemmy.ml 34 points 9 months ago

Stay the fuck away from anything that's organized over discord. Mod abuse and Nazis are a guarantee.

[-] Blisterexe@lemmy.zip 34 points 9 months ago

What? I agree that discord is a bad platform but those aren't a guarantee

[-] Omega_Haxors@lemmy.ml 6 points 9 months ago* (last edited 9 months ago)

Just when I finally think I've found one which is safe, I am painfully reminded of my place.

[-] davel@lemmy.ml 28 points 9 months ago

People organizing on Discord when Matrix exists 🙄

[-] Daeraxa@lemmy.ml 3 points 9 months ago

Its the same as the GitHub problem though, if you want to get community involvement then the necessary evil is to go where the people are. We use GitHub and Discord as that is where the vast majority of our users are, our Lemmy community sees barely any activity over our subreddit, we have barely anyone clamouring for Matrix or IRC. Our Mastodon is probably our only large 'fedi or fedi—adjacent' platform and thats because we drew the line at twitter. Would I love to get away from Discord? Absolutely, but that limits our ability to have an active community whilst we are still growing the project.

[-] Sotuanduso@lemm.ee 9 points 9 months ago

I'm involved in a few projects that are organized over private Discord servers. No mod abuse or Nazis involved.

[-] Omega_Haxors@lemmy.ml 33 points 9 months ago

My biggest nightmare is one day you will go on to a random website and when you press "contact us" it opens an invite to a discord server.

[-] TonyTonyChopper@mander.xyz 9 points 9 months ago

or better yet a QR code to scan in the Discord App. Great way to get your account credentials stolen

[-] redcalcium@lemmy.institute 10 points 9 months ago

You old farts should keep up with times. /s

[-] Sibbo@sopuli.xyz 9 points 9 months ago

This is often done by people while the project is unstable. No need to write documentation that gets outdated every few weeks, when you can help people live in discord.

[-] unexposedhazard@discuss.tchncs.de 72 points 9 months ago

thats understandable but at least use something searchable that has tagging capabilities and is archivable so that you can come back to it years later

[-] renzev@lemmy.world 27 points 9 months ago

D*scord is technically searchable and fairly archiveable (messages never get deleted due to old age (in my experience at least) or if the original poster deletes their account). And some d*scord servers even have a Q&A mode similar to st*ck *verflow. But yeah, not the right tool for the job, not to mention ABSOLUTELY PROPRIETARY

[-] cheerjoy@lemmy.world 37 points 9 months ago

I think what they really mean is searchable without an account, but otherwise you're right.

[-] metaballism@slrpnk.net 34 points 9 months ago

But also Discord search is catastrophically bad and won't find lots of matches.

[-] vithigar@lemmy.ca 13 points 9 months ago

Or find lots of things that aren't matches because it's a fuzzy search with no way to search for exact text.

[-] BeefPiano@lemmy.world 24 points 9 months ago

I’ve never seen Discord messages turn up in any Google or DuckDuckGo search

[-] renzev@lemmy.world 4 points 9 months ago

Kinda tempted to make a bot that automatically joins d*scord servers, indexes all the messages, and publishes them to a public website

[-] computergeek125@lemmy.world 10 points 9 months ago

Why are you redacting platform names like it's profanity? My brain keeps trying to read it as markdown....

[-] renzev@lemmy.world 5 points 9 months ago* (last edited 9 months ago)

Same reasons you'd censor profanity. To show that I don't necessarily agree with or support them. Maybe I should start using the vomit emoji instead of asterisks like u/pancakes [joking].

[-] pixelscript@lemmy.ml 8 points 9 months ago

To me it comes off like you're irrationally afraid to invoke its name.

I get and appreciate that you're trying to make a statement here, but in my opinion it isn't landing the way you think it is. By giving its name special reverence you're needlessly elevating it, not diminishing it.

[-] HerbalGamer@sh.itjust.works 5 points 9 months ago

Well that's just fucking bullshit.

load more comments (1 replies)
[-] SexualPolytope@lemmy.sdf.org 2 points 9 months ago

Zulip is a little better in this regard. I'm involved in Lean, which uses Zulip as the primary mode of support and documentation. While it's usable, I still think that a Discourse style forum is the way to go.

[-] dgriffith@aussie.zone 66 points 9 months ago* (last edited 9 months ago)

when you can help people live in discord.

That live support is super handy when you're 8 timezones apart from the maintainers.

  • Hey there, how do I get this thing to compile?

11 hours later

  • Ok just need to make sure you have this list of prerequisites installed and then we can walk you through the compilation process.

6 hours later

  • Nevermind, I built and installed another project.
[-] T156@lemmy.world 2 points 9 months ago

Or if you find the project a while later, and the link/server is dead, either because the maintainer forgot to update the link, or the server shut down/removed invites for some reason, like spam prevention.

[-] wizardbeard@lemmy.dbzer0.com 34 points 9 months ago

There needs to be some plan to migrate to stable documentation at some point though.

Hell, even a small traditional forum is better searchable.

What I see happen is that the people with the knowledge get so busy answering questions in discord that it impacts the efforts on documentation and on the software itself.

[-] Zacryon@feddit.de 7 points 9 months ago

I am already happy if there is any documentation at all. And I am euphoric if it doesn't suck, i.e. sufficiently detailed and up to date.

So I guess Discord is better than nothing. But sure it's a turn off.

[-] AgnosticMammal@lemmy.zip 4 points 9 months ago

Log into discord, copy the documentation and create a PR with it. (Or make a wiki?)

[-] avidamoeba@lemmy.ca 4 points 9 months ago
load more comments
view more: next ›
this post was submitted on 28 Jan 2024
906 points (100.0% liked)

Programmer Humor

32485 readers
463 users here now

Post funny things about programming here! (Or just rant about your favourite programming language.)

Rules:

founded 5 years ago
MODERATORS