When writing documentation for a package aimed at CTAN, what should every manual contain? Specific examples of concise yet complete documentation are valued.
This is one of those (hopefully) big list questions, so please CW.
EDITED Based on helpful comments:
Standard sections to include (not necessarily in this order):
Suggested sections (though not required):
For a specific example, my favorite is complete yet not concise whatsoever: The TikZ-PGF manual. That document is a work of art.
|show 5 more comments|
Some big projects with exceptional documentation:
Obviously, the demands are different for smaller projects, but bear in mind the things these projects do well...
As an example of the other end of the spectrum, here's a package that currently has fairly poor documentation: moreenum. (I am the author of it, so I can criticise it without anyone getting upset. Nowhere in the documentation have I really explained how to use the package. Now, it is a fairly simple package and it should be obvious. But I think it's better to spell everything out. I will add a brief section with some examples of usage to the docs in the next release.
|show 2 more comments|