Comment on How to reformat CF-Card correctly for the Psion 5 & 5mx
Semi_Hemi_Demigod@lemmy.world 3 weeks ago
Do you have a job writing documentation? Because you should.
Comment on How to reformat CF-Card correctly for the Psion 5 & 5mx
Semi_Hemi_Demigod@lemmy.world 3 weeks ago
Do you have a job writing documentation? Because you should.
foliumcreations@lemmy.world 3 weeks ago
Ohh you… That’s very nice of you to say.
No I don’t work with writing documentation, but I’ve found that often times the "how to’s " miss the explanation part between steps, or don’t show enough examples for novices. Understanding what you are doing is sort of the point, and not adding context will make it harder for the reader to navigate any roadblocks that they may encounter. A step by step instruction shouldn’t leave you stuck on a step because the writer expects that you know how to navigate or find a specific menu. Unless it is explicitly stated of course. I don’t expect expert level documentation to also go through all the basics.
Semi_Hemi_Demigod@lemmy.world 3 weeks ago
You would be amazed how many people who write docs professionally don’t understand that sort of thing.