Skip to content

This is an early unpublished editor's draft; content is incomplete and subject to change.

Clear structure review

assertion

Normative Text

[Title, role, or organization] asserts that:

  • Our organization has a process and policy for reviewing written content for clear structure before publication. The process includes confirming:
    • all of the core requirements in the Structure guideline are met
    • content sections are as concise as possible
    • icons are considered as possible ways to help users understand the content structure and identify key parts, and
    • authors consider when to turn sentences into lists to make the information easier to understand and remember
  • If a style guide is used by authors, it must provide guidance on these aspects of clear structure.
  • If author training is provided, it must provide guidance on these aspects of clear structure.

Information that needs to be included publicly:

  • Title, role or organization making the assertion (if different from the conformance claim).
  • Date of when the policy was implemented.
  • Date of assertion (if different from the date of the conformance claim).

Recommended internal documentation (Informative):

  • Copy of the policy implementing the clear structure review.
  • Whether training was provided for authors
    • Date training was provided.
    • Number or proportion of authors who completed the training.
  • A copy of the style guide (if any) where clear structure review has been defined.

Tests

This content needs to be written.