A directory of resources inthe field of technical communication.

Articles>Documentation>User Centered Design>Minimalism


About this Site | Advanced Search | Localization | Site Maps

 

1.
#32171

The Almighty Thud

If you document everything, you are giving everything an equal weight. Do that for a complex system, and you are buried in detail. In any system there are some aspects that are more important than the others, key aspects of the system that once understood, will help someone to learn more. The art in documentation is to find how to document these aspects as clearly as possible. In this you emphasize these areas, and leave the details for the code.

Fowler, Martin. Distributed Computing (1997). Articles>Documentation>User Centered Design>Minimalism