MicrosoftDocs / microsoft-style-guide

Public contribution for Microsoft Style Guide
Creative Commons Attribution 4.0 International
177 stars 88 forks source link

Guidance on this page contradicts guidance on your global communications page #306

Open LauraDSchneider opened 2 years ago

LauraDSchneider commented 2 years ago

Hello Microsoft,

Please note conflicting guidance that should be updated to modern times (global English, global economy, global everything: it's a small world) for improved readability by all.

This advice, specifically, is outdated:

"When a phrase ending with a colon introduces a bulleted list:

1) I recommend deleting this, or better yet specifically say to never do this: use a phrase with a colon followed by list items that complete the phrase. It's confusing enough for native English speakers and anyone skimming text to quickly obtain information. Each bullet point must be a complete sentence, as must lead-ins to lists, to make a text readable, scannable, and readily comprehensible by all readers in all languages with all abilities/disabilities.

2) That advice specifically contradicts your advice on https://docs.microsoft.com/en-us/style-guide/global-communications/writing-tips:

"Limit your use of sentence fragments. Sentence fragments can be hard to translate."

I completely agree. Fragments are just plain wrong. I also know that removing fragments, particularly avoiding lead-in list fragments like this, is a main concept in both of the global/international English reference books cited at the bottom of your Global communications main page (https://docs.microsoft.com/en-us/style-guide/global-communications/), by Kohl and Weiss.

John Kohl's book is particularly against this, and he has SAS (Statistical Analysis Software) Inc.'s research behind it. (One of my favorite reference books, written by a former co-worker of mine who still owes me his draft 2nd edition...)

--Laura Schneider

I'm a 30-year veteran tech writer/editor and Microsoft Style fan.


Document Details

Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

CBID2 commented 1 year ago

If possible, I'd love to work on this issue @LauraDSchneider! :)