This repository has been archived by the owner on Sep 24, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 171
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Tweaked checklist and moved into base-checklist
- Loading branch information
Cameron Shorter
committed
Jun 7, 2021
1 parent
35f916e
commit fb8586a
Showing
2 changed files
with
6 additions
and
24 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,15 +1,12 @@ | ||
# {Doctype} checklist | ||
{ | ||
Tip: | ||
|
||
* Before writing your {doctype} document, you should plan to address all items on the following checklist. Before finalizing, you should check they are complete. | ||
|
||
} | ||
This checklist list all items which should be addressed before completing a {doctype} document. It should be considered by an author while writing, and should used to guide reviewers. | ||
|
||
## Checklist | ||
* [ ] The document has been reviewed: | ||
* [ ] For clear writing and alignment with the writing style guide, ideally by a technical writer or editor. | ||
* [ ] For alignment with the {doctype} template, ideally by a technical writer, information architect, or content strategist. | ||
* [ ] For alignment with the [{doctype}-template](../{doctype}/{doctype}-template.md), ideally by a technical writer, information architect, or content strategist. | ||
* [ ] For technical accuracy, ideally by a technical subject matter expert. | ||
* [ ] {Further doctype specific checklist items ... .} | ||
* [ ] {Further doctype specific checklist items.} | ||
|
||
_TBD: See also: [the documentation maturity checklist](https://github.com/google/opendocs/blob/main/audit/checklist.md)_. | ||
## See also | ||
See also: [the documentation maturity checklist](https://github.com/google/opendocs/blob/main/audit/checklist.md). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters