• 0 Posts
  • 1 Comment
Joined 1 year ago
cake
Cake day: June 9th, 2023

help-circle
  • 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.

    I agree that the ideal is for software to not need any documentation. In my experience, I have yet to see software that rises to that task and is used across a variety of experience levels and societal cross sections.