OAR

RTEMS GNU Tools On-Line Library


Documentation

PREV UP NEXT Bookshelf GNU Coding Standards

Chapter 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.

  • GNU Manuals Writing proper manuals.
  • Doc Strings and Manuals Compiling doc strings doesn't make a manual.
  • Manual Structure Details Specific structure conventions.
  • License for Manuals Writing the distribution terms for a manual.
  • Manual Credits Giving credit to documentation contributors.
  • NEWS File NEWS files supplement manuals.
  • Change Logs Recording Changes
  • Man Pages Man pages are secondary.
  • Reading other Manuals How far you can go in learning from other manuals.

  • PREV UP NEXT Bookshelf GNU Coding Standards

    Packaging copyright © 1988-2000 OAR Corporation
    Context copyright by each document's author. See Free Software Foundation for information.