美文网首页技术文档写作
【学习总结】Microsoft Manual of Style

【学习总结】Microsoft Manual of Style

作者: Joy的未来十年 | 来源:发表于2021-10-01 15:13 被阅读0次

目前公司写作风格指南以Microsoft Manual of Style (MMoS) 为蓝本,写作语言要求介于formal与informal之间,较之Moodys时formal的STE写法,灵活很多。

以往STE写法较为固定死板,力求结构清楚,便于ESL用户辨析句子成分,用语上没有什么发挥空间。但好处是:可以把工作重点放在:task-based writing、清晰的逻辑结构、以及极简的语言上。

目前公司写作风格中informal的语风让我需要时间来适应,也让我看到了努力的方向:1. informal中如何保证语法正确,特别是介词、冠词、标点的用法正确到位。2. 行业术语常用动词的积累。

以下记录仅用于记录与Moodys写作风格有出入之处,以及体会较深的规则,便于强化记忆。

Web版MMoS,见https://docs.microsoft.com/en-us/style-guide/welcome/

Friendly, conversational style and tone

Use of contractions

Example: it's, isn't, don't, you're, can't

Note: Avoid more ambiguous ones such as there'd, it'll, and they'll

Omit "That" that does not introduce restrictive clauses.

Example: Make sure your anitivirus software is up to date.

Note: "Make sure" 后一般可以不跟that,此处并不是限制式定语从句。

Example: Ensure that your anitivirus software is up to date.

Note: "Ensure" 后一般跟that,此处并不是限制式定语从句。

Example: Type the text that you want to search for.

Note: 此处加that,因为是定语从句。

Use everyday words when you can and avoid formal language that you wouldn't use when speaking to someone in person.

Example: Follow these steps to change your password.

Don't use: Use this procedure to change your password.

Don't use: Use the following steps to change your password.

Note: Moodys写法中,用the following 而不用these. Microsoft直接用these.

Punctuation

Comma

Do not join independent clauses with a comma unless you include a conjunction.

Example: Click Options, and then click Allow Fast Saves.

Note: 这两个是独立的句子.

Do not use a comma between the verbs in a compound predicate.

Example: The setup program evaluates your computer system and then copies the essential files to your hard disk.

Example: The setup program evaluates your computer system, and then it copies the essential files to your hard disk.

Note: 当把第二个句子加入了"it",使前后两部分变成了独立的简单句,而不是复合句。

Use a comma following an introductory phrase.

Example: In Windows, you can run many programs.

Note: 在目前公司,对于introductory adverb,也需要用comma.

Example:  Currently, you can't enroll devices to MDM mode.

Colon

The first word following a colon within a sentence should start with a lower-case letter, except when:

* A colon introduces a direct quotation

* The first word after the colon is a proper noun.

Example: Treat the unknown risk ...: identify the resources available to address it,..

Use a colon at the end of a sentence or fragment that introduces a list. Do not use a colon following a procedure heading or to introduce art, tables, code, or sections.

Example:

To log on to a database  (heading)

1. On ..

2. ...

To log on to a database, follow these steps: (infinitive phrase)

1. On...

2. In the XXX meniua.

Use the Pencil tool to draw thin, free-form lines or curves: (imperative mood)

1. On the XX tab,

2. In the XX group,

The basic steps for adding scrolling to your application are as follows: (indicative mood)

En dash

In a compound adjective in which at least one of the elements is an open compound (such as Windows 2000), use instead of a hyphen.

Example: dialog box–type options  Windows NT–based programs

Em dash

Do not capitalize the first word after an em dash unless the word is a proper noun.

Slash mark

Do not use constructions that contain a slash mark to indicate a choice, such as either/or and he/she. However, and/or is all right to use if you have no other choice.

Use a slash mark in constructions that imply a combination.

Examples: client/server, on/off switch read/write

Usage dictionary

Enable, enabled

Do not use to refer to things that a program makes easy or possible for the user if you can use you can instead. Enable can lead to weak sentences in which the most important fact is buried in an infinitive phrase.

Example:  With Microsft Word 2010. you can save files in HTML format.

Note: No "the" preceding "HTML format"    //无the也由于不会引起用户的猜测,因而可省。在Moodys,基本带形容词的名词前都要加the.

Note: Usually, do not use with to mean by using. With is all right to use in some marketing materials and sometimes with product or service names.

Do not: Microsft Word 2010 enables you to save files in HTML format.

from vs. on

Use from to indicate a specific place or time as a starting point

If you are documenting both mouse and keyboard procedures, use from to indicate a menu from which a user chooses a command.

Example: From the File menu, choose Open.

However, use on to indicate the starting place for clicking a command or option.

Example: On the File menu, click Open.

choose vs. select

Use choose when the user must make a decision, as opposed to selecting (not picking) an item from a list to carry out a decision already made.

Use select to refer to adding a check mark to a check box or to selecting an item in a list box or a combo box list.

Use select to refer to marking text, cells, and similar items that will be subject to a user action, such as copying text. Items so marked are referred to as the selection or the selected text, cells, items, and so on.

type vs. enter

Use type for information that a user must type, such as a password. For information that a user can either type or select from a list, use either type or enter.  You can also use a combination of words such as type or select.  //总之,用Type就可以了!

Examples:

Type your password. (用户只能输入)

Enter the file name. (用户即可输入又可选择)

Type the path to the server or select it from the list.

turn on, turn off

Use instead of power on, power off; start, stop; or switch on, switch off to mean turning the computer on and off.

Use instead of enable, disable to refer to commands or other program features.

Note: Moodys style uses enable, disable. ? 使用Turn on/off来使一个toggle变成available/unavailable (dimmed). 那么如果这个toggle变为available了,我需要设置它为Yes, 该用哪个词? 见Toggle.

It is all right to use turn on, turn off to refer to the status options on webpages, such as those for multimedia, as in, "You can turn off graphics."

Unavailable, dimmed

Use unavailable instead of grayed or disabled to refer to unusable commands and options on the user interface.

Use dimmed only if you have to describe their appearance.

Example: You cannot use unavailable commands until your file meets certain conditions, such as having selected text. These commands appear dimmed on the menu.

Example: If the option appears dimmed, it is unavailable.

toggle

Do not use as a verb. Use switch, click, or turn on and turn off to describe the action instead.

Example: Use the Caps Lock key to switch from typing in captial letters to typing in lowercase letters.

Example: To turn the Ruler on or off, click Ruler on the Edit menu.

that vs. which

That introduces a restrictive clause, which is a clause that is essential for the sentence to make sense. A restrictive clause often defines the noun or phrase preceding it and is not separated from it by a comma.

Example: You will need to supply information about applications that you want to run with Windows.

Which introduces a nonrestrictive clause, which is a clause that could be omitted without affecting the meaning of the sentence. It is preceded by a comma. Nonrestrictive clauses often contain auxiliary or parenthetical information.

Example: Your package contains the subsidiary information card, which you can use to obtain device drivers or local technical support.

set vs. specify

It is worth avoiding words such as set and specify that make general reference to user actions. A better approach is to to specific about the action that the user should take.

Example:  Select a color for XX. Click a color in the list.

Don't use: Specify the color for XXX. Specify a color in the list.

相关文章

网友评论

    本文标题:【学习总结】Microsoft Manual of Style

    本文链接:https://www.haomeiwen.com/subject/zsrunltx.html