Skip to content

#318 Commented out section about gerunds and imperatives in titles. #328

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
Jan 5, 2022
Merged

#318 Commented out section about gerunds and imperatives in titles. #328

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
7 changes: 4 additions & 3 deletions en-US/Design.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,12 +41,13 @@
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>
<para>
Use the gerund form (noun form of verb) for titles, not the imperative mood. For example, "Testing the Product", not "Test the Product".
</para>
<!-- Added an example. -->

</formalpara>
<para>
See the <citetitle>IBM Style Guide</citetitle> for more information.
Expand All @@ -56,11 +57,11 @@
Gerunds should be avoided elsewhere.
See <xref linkend="sentence-structure" />.
</para>
</important>
</important> -->
<formalpara>
<title>File Names, Commands, and Related Terms</title>
<para>
When creating chapter and section titles, do not include file, command, or similar names, and do not include DocBook elements.
When creating chapter and section titles, do not include file, command, or similar names, and do not include markup elements.
Instead, focus on the task at hand and introduce the required file and command names in the text.
Including such objects in titles is generally considered poor technical writing practice.
Depending on how your documentation is built and delivered, including these object types can result in unpredictable results and can even cause failed builds.
Expand Down