StyleGuides / WritingStyleGuide

The official Red Hat guide to writing clear, concise, and consistent technical documentation.
Creative Commons Attribution Share Alike 4.0 International
71 stars 19 forks source link

Update section title for 4.8. Avoiding Ambiguities > Homographic Verbs #506

Closed rclee33 closed 11 months ago

rclee33 commented 11 months ago

I suggest replacing the subsection title “Homographic Verbs” with a more precise title that is easier to understand and more representative of the section content. Although the term "homographic verbs" is technically correct, I think a more commonplace term for the subsection header would help surface this important guidance for writers and other content creators. Additionally, “homographic verbs” is quite a broad category, whereas the section focuses on specific verbs to avoid. Based on the section content, I suggest updating the section title to: "Avoid May and Should". (Other options: “Modal Verbs” or “Avoid Imprecise Verbs”.)

julian-cable commented 11 months ago

Changed the subsection title to "Avoid May and Should". Following this change, also reordered the subsection entries to maintain alphabetical order.