Help text

Drupal modules can provide help text to users in the .info file, and by implementing hook_help(). A hook_help() implementation defines help text for the URLs your module provides (settings pages, editing forms, etc.), indexed by the path to the page. In addition, the special path 'admin/help#modulename' should be used to define an overview help page for each module.

Short Description

A short description of your module goes in the mymodule.info file, in element "description"; this description is displayed on the Modules administration screen, to tell a site administrator what your module does. The description should start with a verb and be relatively concise. Example (from the core node module in Drupal 7):

Help text for your module's paths

Help text for individual paths in your module is generally fairly brief, as it is displayed either at the top of the page or in a block, depending on which version of Drupal you are running. Here is an example of an individual path's help text, from the Node Revisions screen in the Node module [this is part of the node_help() implementation of hook_help()]:

Overview help page for module

The overview help page for your module should follow a standard structure. It should begin with an "About" section (giving a brief overview of what the module does, starting with text like "The Foo module [verb]", and finishing with the link to the module's handbook page) and also contain a "Uses" section (giving details of module functionality, and links to the URLs where each specific functionality can be accessed). Capitalize the name of the module. Here is an example of an overview page from the Node module. First, the hook_help() section that defines the page:

This definition results in the following HTML:

That HTML is rendered like this:

About

The Node module manages the creation, editing, deletion, settings, and display of all site content. For more information, see the online handbook entry for Node module.

Uses

Creating content

When new content is created, the Node module records basic information about the content, including the author, date of creation, and the Content type. It also manages the publishing options, which define whether or not the content is published, promoted to the front page of the site, and/or sticky at the top of content lists. Default settings can be configured for each type of content on your site.

Creating custom content types

The Node module gives users with the Administer content types permission the ability to create new content types in addition to the default ones already configured. Creating custom content types allows you the flexibility to add fields and configure default settings that suit the differing needs of various site content.

Administering content

The Content administration page allows you to review and bulk manage your site content.

Creating revisions

The Node module also enables you to create multiple versions of any content, and revert to older versions using the Revision information settings.

User permissions

The Node module makes a number of permissions available for each content type, which can be set by role on the permissions page.