forked from MicrosoftDocs/architecture-center
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
an initial take on checklist contribution
- Loading branch information
Showing
1 changed file
with
21 additions
and
0 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 |
---|---|---|
@@ -0,0 +1,21 @@ | ||
# Contributing to Checklists | ||
|
||
## Recommend structure | ||
An item in a checklist should include these elements: | ||
1. A concise actionable statement. | ||
2. An explanation of why the statement is relevant to the domain of the checklist. | ||
3. A recommendation for how to address the statement. | ||
4. A list of additional related resources. | ||
|
||
## Example | ||
|
||
``` markdown | ||
### Ensure that all checklist items are consistent | ||
|
||
A consistent structure helps readers better navigate the guidance. By applying these rules to all checklist items we maintain a higher level of quality. The standard structure makes it easier for others to contribute. | ||
|
||
_We recommend using the standard format for all checklist items. If an item doesn't fit the structure, exceptions should be discussed and approved by the content development team._ | ||
|
||
* [The Checklist Manifesto](http://atulgawande.com/book/the-checklist-manifesto/) by Atul Gawande | ||
* [Design Review Checklists](../index.md) | ||
``` |