Skip to content

Commit 9e27f63

Browse files
authored
Analyses README.md copyedits (#257)
1 parent a15161f commit 9e27f63

File tree

1 file changed

+13
-11
lines changed

1 file changed

+13
-11
lines changed

Diff for: analyses/README.md

+13-11
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!-- cSpell:ignore projectname -->
22

3-
# CNCF TechDocs Analysis for OSS Projects
3+
# TechDocs Analysis for CNCF Projects
44

55
## Purpose
66

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

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

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

6565
Each directory might also contain other documents, such as CSV-formatted surveys
6666
of documentation pages.
67+
68+
[implementation.md]: ../docs/analysis/templates/implementation.md

0 commit comments

Comments
 (0)