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.
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.