www.delorie.com/gnu/docs/GNU/standards_32.html   search  
Buy GNU books!

GNU Coding Standards

[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

6. Documenting Programs

A GNU program should ideally come with full free documentation, adequate for both reference and tutorial purposes. If the package can be programmed or extended, the documentation should cover programming or extending it, as well as just using it.

6.1 GNU Manuals  Writing proper manuals.
6.2 Doc Strings and Manuals  Compiling doc strings doesn't make a manual.
6.3 Manual Structure Details  Specific structure conventions.
6.4 License for Manuals  Writing the distribution terms for a manual.
6.5 Manual Credits  Giving credit to documentation contributors.
6.6 Printed Manuals  Mentioning the printed manual.
6.7 The NEWS File  NEWS files supplement manuals.
6.8 Change Logs  Recording Changes
6.9 Man Pages  Man pages are secondary.
6.10 Reading other Manuals  How far you can go in learning from other manuals.

  webmaster   donations   bookstore     delorie software   privacy  
  Copyright 2003   by The Free Software Foundation     Updated Jun 2003