Next: Issues, Previous: Creating Packages, Up: Packaging [Contents][Index]
Some random notes on documenting your package.
Do write a Texinfo file. It’s not that hard to do basically, and even using the more advanced features of Texinfo soon become natural. For a start, just grab the template Samples/package.texi from the XEmacs Packaging System source tree, and drop your current README into the Top node. At least this way your documentation will be accessible from the standard Info readers. Next, try to add lots of cross-referencing and logical markup, and then node structure.
Address both end users and developer issues. You may not be the maintainer forever.
If you are maintaining a package that is part of the GNU Emacs
distribution, you’ll likely find that you occasionally synchronize your
package with the GNU Emacs sources. When you synch a file,
conventionally you should place a comment just above the standard
;;; Code comment that looks like this:
;; Synched with: ;; GNU Emacs 21.1, 2002-02-08, Stephen Turnbull <stephen@xemacs.org>
This comment is a status flag; the ChangeLog doesn’t really give the same information.
Do maintain a detailed ChangeLog.