>>> [!note] Migrated issue <!-- Drupal.org comment --> <!-- Migrated from issue #955134. --> Reported by: [mikey_p](https://www.drupal.org/user/62496) >>> <p>This task is about documenting the process and materials that a contributed module or theme should provide to end users, including installation, usage, FAQ, samples, themes, snippets, and troubleshooting for a module. This documentation will serve as a guide to individuals wishing to document their modules.</p> <p>For examples, please look at the documentation provided in <a href="http://drupal.org/node/206719">http://drupal.org/node/206719</a>.<br> <a href="http://drupal.org/handbook/modules/flag">http://drupal.org/handbook/modules/flag</a></p> <p>This guide should contain recommendations for which pages should be included in a module's documentation, the page ordering, the recommended markup and layout for sections, as well as screenshot guidelines. </p> <p>Relevant items include: </p> <ul> <li>Installation - what items should be documented for each module, and what items are common to all modules (and thus to not need to be documented)</li> <li>Basic usage - This should include configuration, where to find settings, permissions, where to find the in-module help, etc. Portions of this such as permissions, and location of configuration should be standardized as much as possible so that documentation between modules is consistent.</li> <li>FAQ - guidelines for adding an FAQ to the documentation, what type of questions should be listed, when should items be explained inline, vs. moving them to a separate page</li> <li>Sample usage - if applicable, provide a common use case of the module as an example</li> <li>API documentation - If applicable show how to document the basic usage of a modules API</li> <li>Sample snippets - If applicable, show how to style and include code snippets</li> <li>Troubleshooting - determine if this section should be included, or come up with guidelines for when this section should be included, or what items are common to all modules, and should be documented elsewhere</li> <li>Theming - determine how theming information for a contributed module should be documented, should only the most common use cases be shown, or should a list of all themeable functions be included?</li> <li>Determine what other sections could apply for contributed modules or themes</li> </ul> <p>All of this should be documented in our handbook somewhere with both guides as to what content should be included as well as what tags and markup should be used to style the documentation in a manner consistent with drupal.org documentation including screenshot guidelines, including what themes should be used, sizing and image format, as well as whether items should be uploaded externally, or to drupal.org.</p>