Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Analyses README.md copyedits #257

Merged
merged 1 commit into from
Jun 13, 2024
Merged

Analyses README.md copyedits #257

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 13 additions & 11 deletions analyses/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<!-- cSpell:ignore projectname -->

# CNCF TechDocs Analysis for OSS Projects
# TechDocs Analysis for CNCF Projects

## Purpose

Expand Down Expand Up @@ -49,18 +49,20 @@ The analyses are in one of two formats depending on when they were written.
Earlier analyses (**0001** - **0007**) are Markdown files, each of which is the
sole artifact of the analysis.

Subsequent analyses (**0008-** forward) each has its own directory containing
Subsequent analyses (**0008-** forward) each have their own directory containing
three analysis artifacts:

- `projectname-analysis.md` evaluates the project documentation and provides
comments and recommendations in a manner very similar to the Round 1 tech doc
assessments. This document is based on the analysis template and accompanying
criteria developed for the Round 1.
- `projectname-implementation.md` provides concrete actions that can be
implemented by project contributors. Its focus is on specific, achievable work
that will have a strong positive impact on document effectiveness.
- `projectname-issues.md` is a backlog of improvement actions, meant to be
entered as GitHub Issues, derived from `projectname-implementation.md`.
- [analysis.md](../docs/analysis/templates/analysis.md) evaluates the project
documentation and provides comments and recommendations in a manner very
similar to the Round 1 tech doc assessments. This document is based on the
analysis template and accompanying criteria developed for the Round 1.
- [implementation.md] provides concrete actions that can be implemented by
project contributors. Its focus is on specific, achievable work that will have
a strong positive impact on document effectiveness.
- [](../docs/analysis/templates/issues-list.md) is list of improvement actions,
meant to be entered as GitHub issues, derived from [implementation.md].

Each directory might also contain other documents, such as CSV-formatted surveys
of documentation pages.

[implementation.md]: ../docs/analysis/templates/implementation.md