Comment on Concerns Raised Over Bitwarden Moving Further Away From Open-Source
danielquinn@lemmy.ca 1 day agoThis is a common problem with Free software, and honestly I think it’s our biggest one: we build stuff for ourselves and stop there. If we want our stuff to be adopted (which, for things that rely on network effects, we do) then we need to pay more attention to usability.
Here’s a suggestion for anyone starting a project they think they might share. Before you start writing any code, write the documentation. Then rewrite it from the perspective of the least tech-literate person you know who you’d still want to use the project. Only after you’ve worked out how easy it should be for this person to get started, then you can start writing the thing.
CommanderShepard@lemmy.world 1 day ago
Ideally, the project should not require any documentation to read.
Yep, I know, I think everyone should read to learn, but I’ve seen so many times peoples’ spark die once I tell them “I will send you the docs with clear instructions. If you have any questions, let me know :)”. The reply is often " Oh, but it should tell me where to click".
Or maybe it’s because the docs are too difficult, I don’t know.
danielquinn@lemmy.ca 1 day ago
Generally, I agree. I think what I meant by the above is “how would you tell someone how to use the thing”. My favourite example is email vs email-with-PGP.
How do you send an email?
How do you send a PGP-encrypted email
Let’s first talk about this thing called a “keyserver”. Once you know what that is, you’ll have to go out and find some keys to add to it. We’re not going to talk about styling your message 'cause that’s not something you should be able to do… etc. etc.
EssentialNPC@lemmy.world 1 day ago
Good documentation should, in part, tell people where to click. I have designed software documentation for high performing individuals at leading global companies, and I have designed software and hardware documentation for minimum wage fast food workers with limited English proficiency. In both extremes, I showed them exactly where to click on the screen at each step.
You might not need that level of help, but many people do. Others do not strictly need it, but they prefer the simple instruction set. “Click here then here,” instructions ease the transition into a new system one needs to learn, or it removes the need entirely to learn a system one uses infrequently.
The problem is that making good documentation is difficult and time consuming. It relies on a fundamentally different skill set than coding or even UI design.
Allero@lemmy.today 1 day ago
The docs are not only often difficult for an inexperienced user, they commonly omit points of failure.
Various prerequisites, problematic settings, etc. etc. should always be considered.