Skip to content

Added updated wording about verbs in titles #444

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

Merged
julian-cable merged 1 commit into from
Nov 30, 2022
Merged

Added updated wording about verbs in titles #444

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
13 changes: 7 additions & 6 deletions en-US/Design.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,14 +46,15 @@
Do not use terminating periods.
</para>
</formalpara>
<!-- Commenting out this section following a change of advice.
<formalpara id="imperative-mood">
<title>Avoid Imperative Mood</title>
<formalpara id="verbs-titles">
<title>Verbs in Titles</title>
<para>
Use the gerund form (noun form of verb) for titles, not the imperative mood. For example, "Testing the Product", not "Test the Product".
Usually, you start a title with the gerund form of a verb, which ends with "-ing", for example "Creating Branches". Choose a verb that refers to specific actions that users take, such as "Configuring", "Creating", "Installing", and "Merging".
</para>

</formalpara>
<para>
The gerund verb form is not always required. For example, avoid verbs such as "Describing", "Introducing", and "Understanding", because they add little value. Instead, use a more specific verb or omit the verb. For example, instead of "Describing Initial Git Configuration", you can use "Initial Git Configuration".
</para>
<para>
See the <citetitle>IBM Style Guide</citetitle> for more information.
</para>
Expand All @@ -62,7 +63,7 @@
Gerunds should be avoided elsewhere.
See <xref linkend="sentence-structure" />.
</para>
</important> -->
</important>
<formalpara>
<title>File Names, Commands, and Related Terms</title>
<para>
Expand Down