Skip to content
This repository has been archived by the owner on Sep 24, 2022. It is now read-only.

Commit

Permalink
Tweaked checklist and moved into base-checklist
Browse files Browse the repository at this point in the history
  • Loading branch information
Cameron Shorter committed Jun 7, 2021
1 parent 35f916e commit fb8586a
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 24 deletions.
15 changes: 6 additions & 9 deletions base/base-checklist.md
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).
15 changes: 0 additions & 15 deletions base/base-theory.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,12 @@
# {Doctype} theory

{Tip:

* "Tips" should be removed from the final xxx-template-theory.
}

This {doctype}-theory document provides reasoning, justifications, and links to research relevant to {doctype} documentation. It aims to empower authors to "think like a tech writer and expert in {doctype} documents" and make decisions backed by best practices.

**Version:** {MAJOR.MINOR.PATCH}

**Last updated:** {Month DD, YYYY}


## Checklist

Before writing your {doctype} document, you should plan to address all items on the following checklist. Before finalizing, you should check they are complete.

* [ ] 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 technical accuracy, ideally by a technical subject matter expert.
* [ ] {Further doctype specific checklist items ... .}

## User stories

When writing, it is important to understand who you are writing for, and ensure that you provide just the right amount of information to address their needs. The following user stories should help you achieve that.
Expand Down

0 comments on commit fb8586a

Please sign in to comment.