You are viewing a single thread.
View all comments View context
62 points

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.

permalink
report
parent
reply
44 points

Aren’t you basically describing readthedocs.io?

permalink
report
parent
reply
13 points

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.

permalink
report
parent
reply
21 points

First thing that comes to mind is https://devdocs.io/about

permalink
report
parent
reply
5 points
*

Please consider a Patreon for doc review. I don’t mean reviewing the doc against the project for fitness, as that’s the job of each project to maintain and review their own docs; I mean by a technical writer who can de-localize (you only think I mean ‘internationalize’) the document and make it syntactically and logically correct against a generic, classic style guide.

The rising popularity of really bad errors is definitely turning me off from videos or documentation from a few sources with a lot of churn. It ruins the flow and it robs the assumption of authority which I’d argue is an important part of any documentation.

permalink
report
parent
reply
2 points

That is a good idea. I am fairly certain I could get funding and/or loaned resource time for English, Spanish, French and German, but crowd funding incentivized localization for other regions is brilliant.

permalink
report
parent
reply
3 points

Also I’d rather just have these things in the repository.

permalink
report
parent
reply

linuxmemes

!linuxmemes@lemmy.world

Create post

Hint: :q!


Sister communities:

Community rules (click to expand)

1. Follow the site-wide rules
2. Be civil
  • Understand the difference between a joke and an insult.
  • Do not harrass or attack members of the community for any reason.
  • Leave remarks of “peasantry” to the PCMR community. If you dislike an OS/service/application, attack the thing you dislike, not the individuals who use it. Some people may not have a choice.
  • Bigotry will not be tolerated.
  • These rules are somewhat loosened when the subject is a public figure. Still, do not attack their person or incite harrassment.
3. Post Linux-related content
  • Including Unix and BSD.
  • Non-Linux content is acceptable as long as it makes a reference to Linux. For example, the poorly made mockery of sudo in Windows.
  • No porn. Even if you watch it on a Linux machine.
4. No recent reposts
  • Everybody uses Arch btw, can’t quit Vim, and wants to interject for a moment. You can stop now.

Please report posts and comments that break these rules!

Community stats

  • 6.6K

    Monthly active users

  • 1.3K

    Posts

  • 69K

    Comments