Linked by Thom Holwerda on Tue 6th May 2008 15:15 UTC, submitted by Shlomi Fish
Thread beginning with comment 313186
To view parent comment, click here.
To read all comments associated with this story, please click here.
To view parent comment, click here.
To read all comments associated with this story, please click here.
News
Linked by Thom Holwerda on 05/25/13 0:45 UTC
Linked by Thom Holwerda on 05/24/13 23:59 UTC
Linked by Thom Holwerda on 05/24/13 22:33 UTC
Linked by Howard Fosdick on 05/24/13 21:41 UTC
Linked by Thom Holwerda on 05/24/13 14:44 UTC
Linked by Thom Holwerda on 05/23/13 23:22 UTC
Linked by Thom Holwerda on 05/23/13 22:04 UTC
Linked by Thom Holwerda on 05/23/13 22:01 UTC
Linked by Thom Holwerda on 05/23/13 17:52 UTC
Linked by Thom Holwerda on 05/22/13 22:23 UTC
More News »
Sponsored Links



Member since:
2006-10-08
From a developer's standpoint (and maybe a user's, too), I like this point most:
This is the manual that the user can fall back on when points 1) and 2) don't hold true. Every feature needs to be documented, with more material focused on the more complex aspects of the software. For example with an image manipulation package, there's no real need to document most of the items under the standard File, Edit menus. However, it would be good to document the functionality of filters. It would be even better if you documented how to perform common tasks, e.g. red eye removal, sharpening and image, noise reduction, etc.
Picking up your example of an image manipulation program, there are some features that are interesting for, let's say, a graphics engineer for commercials, a photo technician or a guy who postprocesses images for a newspaper. Words like "histogram", "color separation" or "handling of artifacts" come into mind - words the average user (who possibly insists on having a pirated copy of the latest "Photoshop" on his PC in order to watch his holiday pictures) does not understand. --- On one hand, a good documentation could explain what these functions are used for, how they work and how you could use them for specific problems. On the other hand, the first mentioned professionals will know, they don't need such kind of documentation.
Documentation in general is important. At this point, I'm usually praising the BSD operating systens where everything (system binaries, tools and utilities, maintenance procedures, kernel interfaces, drivers, library calls and file layouts) have their own manpage which is available without any external connection just after install. And you have the system handbook on your hard disk, too, in different languages. In my opinion, it's great just to type "man mencoder" or something similar to get a manpage that as been written with the user in mind, containing examples and explainations that are easy to follow and that do enable the reader to achieve his goal. Sadly, this tradition doesn't seem to be followed anymore by "modern" applications...