Guidance on how to write excellent documentation
>>> [!note] Migrated issue <!-- Drupal.org comment --> <!-- Migrated from issue #3581687. --> Reported by: [webchick](https://www.drupal.org/user/24967) Related to !6 >>> <h3 id="summary-problem-motivation">Problem/Motivation</h3> <p><a href="https://www.drupal.org/about/core/policies/core-change-policies/core-gates/documentation">https://www.drupal.org/about/core/policies/core-change-policies/core-gates/documentation</a></p> <ul> <li>Content Style Guide - <a href="https://www.drupal.org/drupalorg/style-guide">https://www.drupal.org/drupalorg/style-guide</a></li> <li>README.md template - <a href="https://www.drupal.org/docs/develop/managing-a-drupalorg-theme-module-or-distribution-project/documenting-your-project/readmemd-template">https://www.drupal.org/docs/develop/managing-a-drupalorg-theme-module-or-distribution-project/documenting-your-project/readmemd-template</a></li> <li>Guidance on documenting contrib modules - <a href="https://www.drupal.org/docs/develop/managing-a-drupalorg-theme-module-or-distribution-project/documenting-your-project/module-documentation-guidelines">https://www.drupal.org/docs/develop/managing-a-drupalorg-theme-module-or-distribution-project/documenting-your-project/module-documentation-guidelines</a></li> </ul> <h4 id="summary-steps-reproduce">Steps to reproduce</h4> <h3 id="summary-proposed-resolution">Proposed resolution</h3> <h3 id="summary-remaining-tasks">Remaining tasks</h3> <h3 id="summary-ui-changes">User interface changes</h3> <h3 id="summary-api-changes">API changes</h3> <h3 id="summary-data-model-changes">Data model changes</h3>
issue