Hi Jim,

Thanks for your input.

The new publishing process makes it a lot easier write and update
documentation, so that is a major obstacle removed.

I agree with what you are saying but as a general rule, but
documentation is never going to be just right because the audience is at
different levels of understanding.

Personally I like something like this:

Click [Resize FS] to resize the file system--see "Resizing file
system".

An clear action with a brief concise description and a link to detailed
information.

So:
    
- An expert would read: Click [Resize FS]
- A normal user would read: Click [Resize FS] to resize the file
  system
- While a novice would read: Click [Resize FS] to resize the file
  system--see "Resizing file system".
  
regards
Greg


------------------------------------------------------------------------
Greg Erskine's Profile: http://forums.slimdevices.com/member.php?userid=7403
View this thread: http://forums.slimdevices.com/showthread.php?t=112996

_______________________________________________
unix mailing list
[email protected]
http://lists.slimdevices.com/mailman/listinfo/unix

Reply via email to