If the documentation is on discord, there is no documentation. Documentation has to be freely available, otherwise it doesn’t count.
Friendly reminder that open source projects don’t just need coders contributing to them.
Technical writers are very appreciated.
I’m trying to get my feet wet in FOSS by making small doc PRs since I’m way too scared to actually touch code. It’s not fun, but it is satisfying.
Firstly, discord is entirely the wrong medium for documentation.
Secondly, documentation should be at least as accessible as the code. That is to say, if I can view the code without creating an account for some service, then I should also be able to read the documentation too.
Documentation is bad enough. But it’s worse when that’s the only channel to get support. I once read a project maintainer boast that they never read the bug reports and issues on github and if anyone had a bug to just chat him up discord. I mean, dude, no wonder nobody uses your software or takes it seriously. Much less want to collaborate on the development.
Documentation is different from technical support and neither should be done on Discord.
One of the stupidest trends of all time.
There is FOSS alternatives out there like Revolt or just plain old IRC which is good enough imo. The Discord bullshit is so annoying.
All chat programs are shit for long term accumulation of knowledge. Discord, revolt, IRC, they’re all just as bad for it.
Forums are where you’ll find people who are actual experts discussing because they want to be able to easily reference previous posts by other people.
Where’s lemmy in regards to this?
Lemmy/Reddit style platforms are good at generating short term discussions, it’s threaded chats.
The main features that makes forums the best to accumulate knowledge is bumping and linear discussions. There’s only one discussion that everyone is following if they want to talk about a specific subject, the knowledge on that subject is centralized and keeps accumulating instead of requiring to be constantly repeated because the previous thread is lost to time. The linear discussion means you don’t have to go back up and start reading a different branch to know what some other people are talking about (which often times leads to having many people basically saying the same thing without realizing it), all new replies appear in chronological order and people quote others to provide context when necessary.
Look on old school forums for more “boomer hobbies” and it’s ridiculous how long conversations can keep going. I provided a link in another reply but the Yamaha WR250 thread on ADVRider has 428k replies since 2013, all that is possible to know about this motorcycle is in they thread and pretty much any question you might have will have its reply in there. There’s car forums with discussions that have been ongoing for decadeS!
Meanwhile on Reddit of you want to ask a question in a thread that was started 24h ago you’re shit out of luck, no one but the OP will know about it. On Lemmy? Everyone sorts by top 6 hours.
In regards to the advrider comment, I don’t find those ridiculously long-running threads all that convenient even though they are very useful. In your example the WR250R thread could have multiple subtopics being discussed at once in the same thread which I find frustrating.
For example, one guy might ask about tires and while that’s being discussed another guy shows up asking about a big bore kit to make more power. Now there are two discussions happening at the same time and all I can do is view the thread chronologically. Then someone else shows up asking what oil everyone uses. Then someone new joins and says “Hey it’s not possible to go back and read through all 2300 pages in this thread, what GPS are you all using?”
Like sure it’s great that all the information is in that one thread but navigating through it only in chronological order can be super frustrating.
ADVRider is more of a “motorcycles in general” community and they try to limit the number of “subcommunities” (the Wr250 thread is in the Thumpers subcommunity), but a WR250 specific forum would have the discussions you’re talking about split up.
The real solution though would be for a “Reddit style forum” to exist, where people can create new subcommunities however they want but to have it work like a forum instead of having threaded discussions that don’t get bumped.
That’s not the point. The point is that pointing to Discord means that there simply is no documentation.
I have been playing with the idea of a documentation.org. Something publicly funded (mostly through corporate and individual donations) that hosts technical manuals, white papers, guides, links to video tutorials (likely YouTube), FAQs, and even links to Discord and/or forums if they exist. Documents are public, free to index (no login to view), version controlled and held in perpetuity.
Obviously there is much more to it, but I think we have reached a point where something like it is required.
Aren’t you basically describing readthedocs.io?
In the most technical terms, yes. The idea is not new or bizarre, but I see the same missteps repeated. For starters, the venture HAS to be a nonprofit with zero need for monetization. It will also need an inviting and easy to navigate user interface, accessible to the most nontechnical of users. You need to have a massive document library from multiple large players from day one, so you need to have a lot of contacts.
As I said it’s not fully cooked, but I have spoken to a few people that could help me make it happen and they seemed open to it.
The very fact that you have to ask and wait for an answer is an inconvenience.
one time, I asked and got a reply that it has been answered already, followed by a rant of why the hell people were asking the same question over and over again. IDK man, maybe you could update the installation instructions in your readme, then people wouldn’t be flodding discord with the same question over and over again.
(it was regarding the project being incompatible with the newest version of a library and you had to manually install an older version to get it to work)
Yes, this exactly! I still cannot fathom how Discord took off. It offers literally no advantages over forums, and introduces some massive disadvantages.
It took off because it was objectively the best catch-all communication option for gamers at the time. It’s still the best option for certain use cases like that, but I’ll never understand why people prefer it for projects, troubleshooting, updates, etc. It seems incredibly lazy and unserious to me. And the current Discord mobile layout is absolutely horrible, making for a totally miserable user experience.
My office has official chat (teams) and unofficial chat (Mattermost).
I don’t think there’s anything wrong with having a more casual discussion platform at work, which is what Mattermost had become.
tbf discord is good for organizing activities in games with online multiplayer. definitely shouldn’t be used for documentation in place of forums though.
Yea, I don’t get the documentation stuff. It’s like saying you’ll use Google Chat history as your documentation.
You don’t see its incredible simplicity as an advantage? That’s crazy
I may be getting old, but I think D*scord (I’m all for cencoring it like a slur) isn’t any more simple than a phpBB or something similar was. Quite the opposite actually, at least for any user trying to navigate the the darn thing.
Having used both, if you can somehow navigate a phbb board then you can easily navigate discord. The only thing stopping you is you.
Maybe navigating is the wrong term. It’s just impossible to find stuff relevant to me on discord. On any given larger server, there may be a few channels I could be interested in - but they are just a single chat log, often with lots of off-topic spam, and many different people having almost separate discussions at the same time. On any given larger phpBB, stuff is mostly separated into different threads with all the off-topic posts being delegated to a single thread. It’s better searchable and better organized.
Simplicity? What fucking simplicity?
Joining via server invites that guide you through sign up, no dedicated server to host (I know, major downside for people who don’t want all their stuff centralized to Discord’s servers), GUI server admin tools, etc.
I think devs tend to vastly overestimate how tech-savvy the average person is. Bring up hosting, DNS, port forwarding, terminal, etc. and they’re going to nope out pretty quick. Provide an option that lets you do everything from a single GUI and they’ll use it. Enough people use it and eventually the tech-savvy folks have to follow because that’s where everyone is.
That’s absolutely not to say that it’s a good medium for documentation. I will always prefer well-written and organized docs first and searchable forums/issue trackers/SO second. But that second group has a lot of tech elitism and devs who are (perhaps justifiably) short on patience, so Discord seems a lot more accessible to newbies who are asking the most basic questions.
Seriously. My only interactions with discord are in ways that its replaced a simple web forum or IRC channel.
Well if that’s your only exposure to it, then yeah I could see why you think it’s not good.
But if you just want to hang out with a regular group of friends async and in voice chat, it’s pretty damn good.
Skill issue
How does everyone feel about the “isolation” of information exchange? Specifically with systems like discord which encourage you to congregate behind a wall? Historically things like community forums were open to the public and thus indexable.
Hosting documentation on Discord is like hosting it on IRC.
While a useful tool in its own right, it’s entirely the wrong choice for this job.
I have a strong suspicion that 90% of that shit is not being backed up. If a server gets deleted for whatever reason, all the documentation is extra gone with a side of never coming back.
No wayback machine, no wget, no open source. Add in server moderators can go rogue or get hacked at any given time. Recipe for catastrophic shitshows
Discord provides no way to backup and restore a server. There are freemium third party products and some rudimentary open source tools that do so, but yeah, it’s wild how much information about open source software (this also applies to the game development community) is just in a proprietary walled garden with a single point of failure.
