> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cognite.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Content quality overview

> Establishes characteristics, criteria, and checklists to help develop high-quality content consistently.

High-quality content has the following characteristics:

<AccordionGroup>
  <Accordion title="Easy to use" defaultOpen={true}>
    <table>
      <thead>
        <tr>
          <th>Criteria</th>
          <th>Checklist</th>
        </tr>
      </thead>

      <tbody>
        <tr>
          <td>Task orientation</td>

          <td>
            <p>☐ Write for the intended audience</p>
            <p>☐ Present information from the users' point of view</p>
            <p>☐ Focus on users' goals</p>
            <p>☐ Indicate a practical reason for information</p>
            <p>☐ Provide clear, step-by-step instructions</p>
          </td>
        </tr>

        <tr>
          <td>Accuracy</td>

          <td>
            <p>☐ Research before you write</p>
            <p>☐ Verify the information that you write</p>
            <p>☐ Keep information current</p>
            <p>☐ Keep information about a subject consistent</p>
            <p>☐ Use spell checkers, grammar checkers, link checkers</p>
          </td>
        </tr>

        <tr>
          <td>Completeness</td>

          <td>
            <p>☐ Fix things in the UI (if there is one)</p>
            <p>☐ Apply a pattern for disclosing information</p>
            <p>☐ Cover all relevant subjects (and only those)</p>
            <p>☐ Cover each topic only in as much detail as users need</p>
          </td>
        </tr>
      </tbody>
    </table>
  </Accordion>

  <Accordion title="Easy to understand" defaultOpen={true}>
    <table>
      <thead>
        <tr>
          <th>Criteria</th>
          <th>Checklist</th>
        </tr>
      </thead>

      <tbody>
        <tr>
          <td>Clarity</td>

          <td>
            <p>☐ Focus on the meaning</p>
            <p>☐ Eliminate wordiness</p>
            <p>☐ Write coherently</p>
            <p>☐ Avoid ambiguity</p>
            <p>☐ Use technical terms consistently</p>
          </td>
        </tr>

        <tr>
          <td>Concreteness</td>

          <td>
            <p>☐ Consider the skill level and needs of users</p>
            <p>☐ Use elements that fit in the information type</p>
            <p>☐ Elements should be focused, realistic and up to date</p>
            <p>☐ Use scenarios to illustrate tasks and provide an overview</p>
            <p>☐ Make code examples easy to use</p>
            <p>☐ Set the context for examples and scenarios</p>
            <p>☐ Use similies and analogies to relate unfamiliar to familiar</p>
            <p>☐ Use specific language</p>
          </td>
        </tr>

        <tr>
          <td>Style</td>

          <td>
            <p>☐ Use active voice</p>
            <p>☐ Use the right tone</p>
            <p>☐ Avoid gender and cultural bias</p>
            <p>☐ Spell terms consistently and correctly</p>
            <p>☐ Use proper capitalization</p>
            <p>☐ Use consistent and correct punctuation</p>
            <p>☐ Apply consistent highlighting</p>
            <p>☐ Make elements in parallel</p>
            <p>☐ Apply templates and reuse snippets/elements</p>
            <p>☐ Use consistent mark-up tagging</p>
          </td>
        </tr>
      </tbody>
    </table>
  </Accordion>

  <Accordion title="Easy to find" defaultOpen={true}>
    <table>
      <thead>
        <tr>
          <th>Criteria</th>
          <th>Checklist</th>
        </tr>
      </thead>

      <tbody>
        <tr>
          <td>Organization</td>

          <td>
            <p>☐ Put information where users expect it</p>
            <p>☐ Arrange elements to facilitate navigation</p>
            <p>☐ Reveal how elements fit together</p>
            <p>☐ Emphasize main points; make secondary points subordinate</p>
          </td>
        </tr>

        <tr>
          <td>Retrievability</td>

          <td>
            <p>☐ Optimize for searching and browsing</p>
            <p>☐ Guide users through information</p>
            <p>☐ Link appropriately</p>
            <p>☐ Provide a helpful entry point</p>
          </td>
        </tr>

        <tr>
          <td>Visual effectiveness</td>

          <td>
            <p>☐ Apply visual design practices to textual elements</p>
            <p>☐ Use graphics that are meaningful and appropriate</p>
            <p>☐ Apply a consistent visual style</p>
            <p>☐ Use visual elements to help users find what they need</p>
            <p>☐ Ensure that visual elements are accessible to all users</p>
          </td>
        </tr>
      </tbody>
    </table>
  </Accordion>
</AccordionGroup>

For details, see [Developing Quality Technical Information: A handbook for Writers and Editors (IBM Press)](https://www.amazon.com/Developing-Quality-Technical-Information-Handbook-ebook/dp/B00L7ZKJ26/ref=sr_1_fkmr1_1?keywords=develop+quality+technical+documentation\&qid=1552386573\&s=gateway\&sr=8-1-fkmr1).

For automated scoring with AI assistants, use the content-scoring skill where it is installed in your repo. For voice, structure, and Mintlify usage, see **`rules/cognite-styleguide.md`** in the repository (canonical) or the [style guide](/cogdocs/concepts/cogdocs-style-guide) summary.

Before you request review, work through this checklist together with the style guide.