-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Open
Description
Overview
Edit the website for conformance to the [Knative style guide].
Audience: All
Type: All
Context
This issue tracks recommended changes resulting from an analysis of the Knative
documentation commissioned by CNCF. The analysis and supporting documents are
here: https://github.com/cncf/techdocs/tree/main/analyses under 0015-knative
.
Possible Implementation
Related material in the current doc:
Suggested changes:
Specific Knative style rules that will have the biggest impact:
- Use imperatives for headings of procedures. Technical writing best practice
has traditionally been to use gerunds ("-ing" verbs), but this is okay as well.
More imporant is to be consistent. Use the same form for all procedure headings. - Use simple and direct language. To the extent possible, follow the "Voice
and language" guidelines in the style guide. For example, there are 50 instances
of the word "please" in the Knative documentation. Remove these and use simple
imperative sentences for instructions. - Avoid statements that will soon be out of date. This addresses
maintainability. See the [example] in the style guide. There are many instances
of the word "currently" in the Knative documentation. - Spell out words to avoid abbreviations. For example: Replace "E2E" with "end
to end". - Use simple and direct language. For example, from [Concepts]: "The
documentation in this section explains commonly referenced Knative concepts
and abstractions, and helps to provide you with a better understanding of how
Knative works" could be: "This documentation explains what Knative is for and
how it works."
Metadata
Metadata
Assignees
Labels
No labels