Add evals for how-to-write-documentation.md
>>> [!note] Migrated issue
<!-- Drupal.org comment -->
<!-- Migrated from issue #3583241. -->
Reported by: [webchick](https://www.drupal.org/user/24967)
>>>
<h3 id="summary-problem-motivation">Problem/Motivation</h3>
<p><span class="drupalorg-gitlab-issue-link drupalorg-gitlab-link-wrapper"><a href="https://git.drupalcode.org/project/ai_best_practices/-/work_items/3581687" class="drupalorg-gitlab-link">https://git.drupalcode.org/project/ai_best_practices/-/work_items/3581687</a></span> outlines some best practices around writing documentation captured at DrupalCon.</p>
<p>Now that <span class="drupalorg-gitlab-issue-link drupalorg-gitlab-link-wrapper"><a href="https://git.drupalcode.org/project/ai_best_practices/-/work_items/3581832" class="drupalorg-gitlab-link">https://git.drupalcode.org/project/ai_best_practices/-/work_items/3581832</a></span> has been added, per @zorz in <span class="drupalorg-gitlab-issue-link drupalorg-gitlab-link-wrapper"><a href="https://git.drupalcode.org/project/ai_best_practices/-/work_items/3581687" class="drupalorg-gitlab-link">https://git.drupalcode.org/project/ai_best_practices/-/work_items/3581687</a></span>:</p>
<p>it would be nice to have an example of how a good documentation looks like and have the eval system tinker the skill until the score is good enough.
</p>
<p>One way to know that could be with data. Per @hestenet at <span class="drupalorg-gitlab-issue-link drupalorg-gitlab-link-wrapper"><a href="https://git.drupalcode.org/project/ai_best_practices/-/work_items/3581687" class="drupalorg-gitlab-link">https://git.drupalcode.org/project/ai_best_practices/-/work_items/3581687</a></span>:</p>
<blockquote><p>
This is analysis recently done by the Pronovix team as part of an STA grant to support some documentation improvements - would this help?</p>
<p><a href="https://docs.google.com/spreadsheets/d/1QZXAVnVf2wKdpL-8t3y1CtuoFhyaRFPa/edit?gid=619811631#gid=619811631">https://docs.google.com/spreadsheets/d/1QZXAVnVf2wKdpL-8t3y1CtuoFhyaRFPa/edit?gid=619811631#gid=619811631</a></p>
<p>For that matter, they also produced a number of other artifacts, including things like templates and a contributor checklist:</p>
<p><a href="https://drive.google.com/drive/folders/1EOXk8BfvycxpTyVRZzWlvG2MSH6Qetpy">https://drive.google.com/drive/folders/1EOXk8BfvycxpTyVRZzWlvG2MSH6Qetpy</a></p>
</blockquote>
<h3 id="summary-remaining-tasks">Remaining tasks</h3>
<ul>
<li>Decide on an example of "good" documentation (@eojthebrave mentioned <a href="https://www.drupal.org/docs/getting-started/installing-drupal/install-drupal-using-ddev-for-local-development">https://www.drupal.org/docs/getting-started/installing-drupal/install-drupal-using-ddev-for-local-development</a> for the handbook anyway)</li>
<li>Formulate into eval framework language</li>
</ul>
issue