Skip to content

Draft 1 Writer Quality Checklist #1

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

Open
valkyrie69 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Draft 1 Writer Quality Checklist #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions writers-checklist.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
= Writer's Checklist

Before you merge your content, did you...?

* Perform a local build and do a final visual check of your content, including checking for:
** Broken images
** Dead links
** Formatting issues, for example, misnumbered ordered lists (steps) and messed up tables
* Run the link checker to check for broken xrefs
* 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