Skip to content

Conversation

@valkyrie69
Copy link
Owner

@valkyrie69 valkyrie69 commented May 20, 2021

Before merging your PR, did you:

  • Run the link checker to check for broken xrefs
  • Perform a local build and do a final visual check of your content, including checking for:
  • Broken images
  • Dead links
  • Correct rendering of partials if they are used in your content
  • Formatting issues, such as:
    • Misnumbered ordered lists (steps) or incorrectly nested unordered lists
    • Messed up tables
    • Proper indentation
    • Correct header levels
  • Run spell checker
  • Check for orphan files
  • Receive final review and signoff from:
  • Technical SME
  • Product Manager
  • Editor or peer reviewer
  • Reporter, if this content is in response to a reported issue (internal or external feedback)
  • Verify that the software actually got released

@valkyrie69 valkyrie69 changed the title Draft 1 Draft 1 Writer Quality Checklist May 25, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants