Next: Managing Releases, Previous: Writing C, Up: Top [Contents][Index]
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. | |
• 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 from other manuals. |