Carolyn mentioned something I've been meaning to do for ages on #674474: Review and update D7 core module handbook pages, so thought I'd start an issue. We should really create a standard/template for module docs landing pages (ie. the top level page for a particular module). This would provide a consistent guideline for core, and a suggested guideline for contrib as well.
URL alias should always be:
http://drupal.org/documentation/modules/[project-name] - these are all set for core modules, and I do contrib ones as I find them.
Generally it should also loosely follow what's in the Help pages since that's where a lot of the D7 content came from. So something like:
Brief intro (not sure we need to actually put this as a heading like in Help we use "About").
Use cases, and what the module's config options are - optionally divided into D7 then D6 subsections.
Configuration instructions and options. (Could be called "Implementation" - or would that be too technical?)
Technical Specifications for Drupal 7
Eg. from Carolyn for Block module based on Ken Rickard's Field UI docs work:
Core module: Yes.
Related Modules: Dashboard.
Permissions: Administer blocks. Also see the API docs at block permission.
API Documentation: block.admin.inc, block.api.php, block.install, block.module, block_test.module
Template files: block-admin-display-form.tpl.php, block.tpl.php
Other files: block.info, block.css, block.js
Database tables (4): block, block_role, block_custom, cache block. Also see the API docs at block schema.