Documenting your project

There are several types of documentation you can add to a Module, Theme, or other project. This guide will cover the relevant guidelines, teach you how to add help text to the Drupal UI through a module, and other ways to ensure your projects are documented.

Help text standards

Guidelines for writing and formatting help text that appears in the Drupal UI. Applies to both core and contrib.

Module documentation guidelines

Informs how to provide proper documentation for a Drupal module.

Project page template

Content suggestions and template for project pages.

README.md template

Information about content and formatting of project README files.

Working with Drupal's Help system

About the core help landing page and contextual help.

Using simplytest.me as a project demo

Having a sandboxed 'Try a demonstration' link on Drupal.org project pages to evaluate it. Target audience: Drupal project maintainers.

Help Topic Standards

Standards for contributed modules/themes for Help Topics that they provide

Guide maintainers

Webbeh's picture
dddave's picture