1 1 6 Documenting Programs 1 ********************** 1 1 A GNU program should ideally come with full free documentation, adequate 1 for both reference and tutorial purposes. If the package can be 1 programmed or extended, the documentation should cover programming or 1 extending it, as well as just using it. 1
1 · 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. · Printed Manuals Mentioning the printed manual. · 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 1 from other manuals. 1