Adopting minimalism in your docs

Posted by bob on Oct 4, 2017 9:33 PM CST
Opensource.com; By Anni Bond
Mail this story
Print this story

A traditional approach to documentation is to explain everything, down to the features of the user interface. My first project as an intern trying to write good documentation is a great (by which I mean terrible) example of how messy this approach can be. But there’s more to it than that—once you start documenting everything, it becomes easy to lose sight of what the user needs, what the user wants to do, and what task the user is having trouble completing.

Full Story

  Nav
» Read more about: Story Type: Editorial; Groups: Community, Linux

« Return to the newswire homepage

This topic does not have any threads posted yet!

You cannot post until you login.