techdocs/docs/analysis/templates
Patrice Chalin ac83b89179
[CI] Update packages and run checks and fixes (#287)
2025-02-25 12:21:26 -05:00
..
README.md [CI & docs] Rework of analysis docs + improved checks (#256) 2024-06-12 19:24:16 -04:00
analysis.md [CI] Update packages and run checks and fixes (#287) 2025-02-25 12:21:26 -05:00
implementation.md [CI & docs] Rework of analysis docs + improved checks (#256) 2024-06-12 19:24:16 -04:00
issue.md [CI & docs] Rework of analysis docs + improved checks (#256) 2024-06-12 19:24:16 -04:00
issues-list.md [CI & docs] Rework of analysis docs + improved checks (#256) 2024-06-12 19:24:16 -04:00

README.md

TechDoc Analysis Templates

This section contains templates for analyzing a CNCF project's documentation.

Use the templates in this directory to perform a documentation analysis for CNCF. These materials provide:

  • A relatively objective set of criteria (a "rubric") for evaluating existing documentation and website content, infrastructure, and support.
  • An attempt to make the documentation analysis appropriate to the current (or proposed) maturity level for the overall project.
  • Emphasis on effective documentation that serves all users associated with the project.

For guidance in completing a documentation analysis, see Analysis how-to and criteria pages.