cncf
/
techdocs
mirror of https://github.com/cncf/techdocs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update assessments/criteria.md: formatting change 

Small formatting change.
This commit is contained in:
Nate W 2021-06-12 19:01:31 +00:00 committed by GitHub
parent 07a8e4bfb3
commit d323817698
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
assessments/criteria.md
View File

@ -12,7 +12,7 @@ Is the documentation feature complete? (i.e., each product feature is documented
* Are there any key features which are documented but missing task documentation? * Are there any key features which are documented but missing task documentation?
* Is the “happy path”/most common use case documented? * Is the “happy path”/most common use case documented?
Does task and tutorial content demonstrate atomicity and isolation of concerns? (Are tasks clearly named according to user goals?) Does task and tutorial content demonstrate atomicity and isolation of concerns? (Are tasks clearly named according to user goals?)
*If the documentation does not suffice, is there a clear escalation path for users needing more help? (FAQ, Troubleshooting) * If the documentation does not suffice, is there a clear escalation path for users needing more help? (FAQ, Troubleshooting)
* If the product exposes an API, is there a complete reference? * If the product exposes an API, is there a complete reference?
* Is content up to date and accurate? * Is content up to date and accurate?