New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Draft 1 Writer Quality Checklist #1

Open

valkyrie69 wants to merge 1 commit into master from writers-checklist

Owner

valkyrie69 commented May 20, 2021 •

edited

Loading

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


          Draft 1

364b898

valkyrie69 changed the title ~~Draft 1~~ Draft 1 Writer Quality Checklist

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet