From 852a409a56080319e7160dcc9aaa1af267ac52f0 Mon Sep 17 00:00:00 2001 From: julian-cable Date: Fri, 26 Jul 2024 17:21:33 +0100 Subject: [PATCH] Update guidance about 'Overview' as a title --- en-US/Book_Design.xml | 2 +- en-US/Design.xml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/en-US/Book_Design.xml b/en-US/Book_Design.xml index a92191a..ffb2da7 100644 --- a/en-US/Book_Design.xml +++ b/en-US/Book_Design.xml @@ -136,7 +136,7 @@ Overview - Do not use "overview" as a title. No justification was found for using it as a title; anywhere that it might be considered is already covered by either better or more common titles. + Use "Overview" in a title only sparingly, and do not use "Overview" as a title on its own. No justification was found for using it as a title; anywhere that it might be considered is already covered by either better or more common titles. diff --git a/en-US/Design.xml b/en-US/Design.xml index b25ef21..4e42955 100644 --- a/en-US/Design.xml +++ b/en-US/Design.xml @@ -60,7 +60,7 @@ Activities and subtasks that the user should perform can alternatively use an imperative verb for clarity. Imperative verbs are prescriptive, such as "Create" or "Delete". Example: "Assess the Health of an OpenShift Cluster". - In some cases, a verb might not be appropriate because the content is purely informational. Instead of using a vague verb like "Understanding", "Describing", "Introducing", or "Exploring", either use a more specific verb, or use a noun phrase instead of a verb. A noun phrase is descriptive and omits a verb, for example "Installation Overview" or "The OpenShift Web Console." + In some cases, a verb might not be appropriate because the content is purely informational. Instead of using a vague verb like "Understanding", "Describing", "Introducing", or "Exploring", either use a more specific verb, or use a noun phrase instead of a verb. A noun phrase is descriptive and omits a verb, for example "OpenShift Operators" or "The OpenShift Web Console." Avoid a title that consists of only one word.