High quality guides

OK, from all these contributions I made a generic representation of what people want (with some comments). Basically I just mashed all opinions together:

  1. Working
    1. Verified by at least two users
      How to prove that you have completed a guide?
    2. Working system versions specified
  2. Well explained
    1. Can be followed without understanding the topic
      • Is this the same as “can be followed verbatim”?
      • Further specification required. How dumb high quality guide user is?
  3. Well documented
    1. Unnecessary details are hidden in formatting
      i.e. references / see also header, “hide detail” feature
    2. Consistent
      create templates?
    3. Can be followed verbatim
  4. Well formatted
    1. Proper usage of headers
      Specification required
    2. As visual as possible
      Screenshots or code fields (where applicable)
  5. Security implications must be specified
    If there are none, it must say so.
  6. Impacts wide range of users
    Why leave niche guides out?
  7. Well maintained
2 Likes

I think it is mostly possible to work around this problem. Instead of explaining the basics, just don’t explain them, but provide instructions.

Unless there is a specific SOP standard you want to use, I suggest looking in general direction of already existing high quality documentation. I really like gentoo wiki, how about we take their guidelines and adapt them?
p.s. It doesn’t mean we cannot follow the spirit of SOPs, we just need to start from something.

1 Like

What about just letting people vote, and if a guide gets X amount of votes it goes to the quality guides section.

If people collectively can agree a guide is good, it should be enough to consider it good quality.

5 Likes

Great idea! Although it would be hard to manage it as the size of community changes. Also mediocre guide may just be there long enough.

Is it possible to make it proportion of upvotes against number of views + maybe some time restriction (just so the guide wouldn’t be marked high-quality with the first votes and views immediately)?

3 Likes

Do you have a link of an example of what you like? The reason I recommended SOPs is because they are specifically designed to solve the huge problem we have regarding Qubes’s seriously steep learning curve. Qubes is hands down the best operating system in existence by far, the problem is the % of people capable of using it effectively is tiny and mostly comprised of programmers. I think if usability and documentation was improved, it would open things up to the huge number of people in other technical fields like engineering, sciences, etc and would cause the number of Qubes users to skyrocket

1 Like

Agreed. I think the best way to start would be to make a template

1 Like

Sure!

https://wiki.gentoo.org/wiki/Gentoo_Wiki:Guidelines

https://wiki.gentoo.org/wiki/Gentoo_Wiki:Article_blueprints

https://wiki.gentoo.org/wiki/Xfce

2 Likes
Offtopic

I think we should stop making it heavy to ourselves unnecessarily claiming using Qubes OS is hard. Creating one’s threat model, then installing Qubes and put it in a deployment phase is a challenge, I’d agree, but using it from that point is as easy as Windows, or Android.

Any OS is hard to learn when you start with it, not to mention to install it. Qubes OS is no exception to this by any mean.

1 Like

This may be true from a subjective standpoint, but you underestimate the depth to which people are trained to their OS, how relatively fundamentally different Qubes is, and how big of a learning curve that results in. I don’t think too many people are complaining about the difficulty after getting past the curve. (Even then, Qubes isn’t exactly intuitive, and this isn’t as much a UI/dev issue as it is that Qubes as a concept is just so fundamentally different from what people expect.)

5 Likes

I think the biggest issue with Qubes OS for people starting using it is that their knowledge from other OS is not directly applicable (only partially in AppVM). So they have to learn a new OS and new way of thinking.

4 Likes

This exactly.

1 Like
Offtopic

How that differs Qubes from any other OS? “Hey, where to click to get internet browser”? I think you are looking at the things from self perspective: as an advanced user you’re thinking on a regular Windows user. Nope. Advanced users of any OS will adjust easily for their needs (@GWeck for example, me…). Regular users will adjust easily for their needs (“where is browser, where is Word, where is TikTok…”) - just offer them default installation, from the whole OS they will most likely customize wallpapers, either under Windows or Qubes.

1 Like

By asking to provide the logs, as I mentioned in my original post.

I don’t think that all other requirements are so important, apart from this one. People will probably not be able to reproduce the result with a not well documented, inconsistent guide. It the guide is working, it is relatively easy to improve its visible representation. Other users can do it themselves.

4 Likes