[comp.binaries.ibm.pc.d] Style Tips of Documents and Programs

rzhu@watmath.waterloo.edu (Rupert Zhu) (05/03/91)

      Here are some suggestions to moderators and writers of documents 
and/or programs.

Suggestion 1:  Put a name_tag at the beginning of each file, identifying
         the name of this file.  E.g., something like
               FILE:  tsarc122.txt               or
               PROGRAM: folding.c
Reason:  For users who print out a bunch of files, a name_tag in
         each file would be very helpful in identifying the files.

Suggestion 2:  For some utility programs, it may be quite helpful to 
         put out a message at the termination, telling users what have 
         been done.  For example, for the widely used  UUDECODE  program,
         it would be very helpful if a message is posted at the end,
         telling what file has been created from its uuencoded carrier 
         file.
Reason:  It occurs quite often that the original file which is uuencoded
         has a completely different name from its carrier file.  It is not
         always easy to figure out what file is created without looking into
         the uuencoded text.    (Keep novice users in mind.)
In particular, I hope this feature can be added into the uudecode programs
in the Starter's Kit, because novice users need it.  Thanks!


Rupert Zhu
University of Waterloo
======================================================================