Merge pull request #227 from ccard587/missingdescription-cc2

[Bulk] Validation: fixing missing descriptions-cc2
MicrosoftDocs · Jun 7, 2022 · 82177c6 · 82177c6
2 parents f603130 + 5af3418
commit 82177c6
Show file tree

Hide file tree

Showing 25 changed files with 28 additions and 3 deletions.
diff --git a/styleguide/a-z-word-list-term-collections/w/write-only.md b/styleguide/a-z-word-list-term-collections/w/write-only.md
@@ -1,6 +1,7 @@
 ---
 title: write-only - Microsoft Style Guide
 author: pallep
+description: This instructs to always hyphenate with the terms "write-only."
 ms.author: pallep
 ms.date: 01/19/2018
 ms.topic: article

diff --git a/styleguide/a-z-word-list-term-collections/w/write-protect-write-protected.md b/styleguide/a-z-word-list-term-collections/w/write-protect-write-protected.md
@@ -1,6 +1,7 @@
 ---
 title: write-protect, write-protected - Microsoft Style Guide
 author: pallep
+description: Instructs to use "write-protect" as a verb instead of "lock" to refer to the action of protecting disks from being overwritten, use "write-protected" as an adjective, and to always hyphenate both.
 ms.author: pallep
 ms.date: 01/19/2018
 ms.topic: article

diff --git a/styleguide/a-z-word-list-term-collections/x/x-axis.md b/styleguide/a-z-word-list-term-collections/x/x-axis.md
@@ -1,6 +1,7 @@
 ---
 title: x-axis - Microsoft Style Guide
 author: pallep
+description: Instructs to lowercase and hyphenate "x-axis" and on first mention, use category (x) axis to refer to the horizontal axis in charts and graphs.
 ms.author: pallep
 ms.date: 01/19/2018
 ms.topic: article

diff --git a/styleguide/a-z-word-list-term-collections/x/x-coordinate.md b/styleguide/a-z-word-list-term-collections/x/x-coordinate.md
@@ -1,6 +1,7 @@
 ---
 title: x-coordinate - Microsoft Style Guide
 author: pallep
+description: Instructs to lowercase and hyphenate the "x-coordinate," but to not use italic formatting for the x in x-coordinate unless the entire word is italic.
 ms.author: pallep
 ms.date: 01/19/2018
 ms.topic: article

diff --git a/styleguide/a-z-word-list-term-collections/x/x.md b/styleguide/a-z-word-list-term-collections/x/x.md
@@ -1,6 +1,7 @@
 ---
 title: x - Microsoft Style Guide
 author: pallep
+description: Instructs to use a lowercase "x" in italic type as a placeholder number or variable, but not to use it to refer to a generic, unspecified number.
 ms.author: pallep
 ms.date: 01/19/2018
 ms.topic: article

diff --git a/styleguide/a-z-word-list-term-collections/x/xon-xoff.md b/styleguide/a-z-word-list-term-collections/x/xon-xoff.md
@@ -1,6 +1,7 @@
 ---
 title: XON/XOFF - Microsoft Style Guide
 author: pallep
+description: States to note the capitalization and slash on "XON/XOFF."
 ms.author: pallep
 ms.date: 01/19/2018
 ms.topic: article

diff --git a/styleguide/a-z-word-list-term-collections/y/y-axis.md b/styleguide/a-z-word-list-term-collections/y/y-axis.md
@@ -1,6 +1,7 @@
 ---
 title: y-axis - Microsoft Style Guide
 author: pallep
+description: Instructs to lowercase and hyphenate the term "y-axis," but on first mention, refer to the y-axis as the value (y) axis.
 ms.author: pallep
 ms.date: 01/19/2018
 ms.topic: article

diff --git a/styleguide/a-z-word-list-term-collections/y/y-coordinate.md b/styleguide/a-z-word-list-term-collections/y/y-coordinate.md
@@ -1,6 +1,7 @@
 ---
 title: y-coordinate - Microsoft Style Guide
 author: pallep
+description: Instructs to lowercase and hyphenate the "y-coordinate" and not to use italic formatting for the y in y-coordinate unless the entire word is italic.
 ms.author: pallep
 ms.date: 01/19/2018
 ms.topic: article

diff --git a/styleguide/a-z-word-list-term-collections/z/z-axis.md b/styleguide/a-z-word-list-term-collections/z/z-axis.md
@@ -1,6 +1,7 @@
 ---
 title: z-axis - Microsoft Style Guide
 author: pallep
+description: Discusses that in 3D charts, the z-axis shows depth and generally represents values, but instructs to lowercase and hyphenate the z-axis.
 ms.author: pallep
 ms.date: 01/19/2018
 ms.topic: article

diff --git a/styleguide/a-z-word-list-term-collections/z/z.md b/styleguide/a-z-word-list-term-collections/z/z.md
@@ -1,6 +1,7 @@
 ---
 title: z- - Microsoft Style Guide
 author: pallep
+description: Instructs to hyphenate all words referring to entities that begin with z used as a separate letter, such as z-axis, z-coordinate, z-order, and z-test.
 ms.author: pallep
 ms.date: 01/19/2018
 ms.topic: article

diff --git a/styleguide/a-z-word-list-term-collections/z/zero-zeros.md b/styleguide/a-z-word-list-term-collections/z/zero-zeros.md
@@ -1,6 +1,7 @@
 ---
 title: zero, zeros - Microsoft Style Guide
 author: pallep
+description: Discusses when a measurement includes 0, use the plural form of the spelled-out unit of measure, such as zero, not zeroes, as the plural of zero.
 ms.author: pallep
 ms.date: 01/19/2018
 ms.topic: article

diff --git a/styleguide/a-z-word-list-term-collections/z/zip-code.md b/styleguide/a-z-word-list-term-collections/z/zip-code.md
@@ -1,6 +1,7 @@
 ---
 title: ZIP Code - Microsoft Style Guide
 author: pallep
+description: Discusses that it's OK to use ZIP Code in content that's intended for a US audience only. Otherwise, use postal code.
 ms.author: pallep
 ms.date: 01/19/2018
 ms.topic: article

diff --git a/styleguide/a-z-word-list-term-collections/z/zoom-in-zoom-out.md b/styleguide/a-z-word-list-term-collections/z/zoom-in-zoom-out.md
@@ -1,6 +1,7 @@
 ---
 title: zoom in, zoom out - Microsoft Style Guide
 author: pallep
+description: Instructs to use zoom in and zoom out as generic verbs in instructions for all input methods, but not to use dezoom or unzoom.
 ms.author: pallep
 ms.date: 01/19/2018
 ms.topic: article

diff --git a/styleguide/brand-voice-above-all-simple-human.md b/styleguide/brand-voice-above-all-simple-human.md
@@ -1,5 +1,6 @@
 ---
 title: Microsoft's brand voice &#58; above all, simple and human - Microsoft Style Guide
+description: Discusses Microsoft's brand voice, which is simple and human, such as "what" we say, our message, and "how" we say it, our voice. 
 author: pallep
 ms.author: pallep
 ms.date: 01/19/2018

diff --git a/styleguide/capitalization.md b/styleguide/capitalization.md
@@ -1,5 +1,6 @@
 ---
 title: Capitalization - Microsoft Style Guide
+description: Microsoft style uses sentence-style capitalization. That means everything is lowercase except the first word and proper nouns.
 author: pallep
 ms.author: pallep
 ms.date: 04/02/2021

diff --git a/styleguide/chatbots-virtual-agents/care-feeding-bot.md b/styleguide/chatbots-virtual-agents/care-feeding-bot.md
@@ -1,5 +1,6 @@
 ---
 title: Care and feeding of the bot - Microsoft Style Guide
+description: Instructs maintaining the bot and evaluating its effectiveness over time, such as what's working and what isn't.
 author: pallep
 ms.author: pallep
 ms.date: 02/21/2019

diff --git a/styleguide/chatbots-virtual-agents/index.md b/styleguide/chatbots-virtual-agents/index.md
@@ -1,5 +1,6 @@
 ---
 title: Chatbots and virtual agents - Microsoft Style Guide
+description: Discusses chatbots and virtual agents, which is a type of bot that can be used to provide information and answers, and complete tasks.
 author: pallep
 ms.author: pallep
 ms.date: 02/21/2019
@@ -32,5 +33,5 @@ This section includes guidelines and tips to help you create this type of bot:
 
 **Learn more**  
 [Microsoft's AI vision, rooted in research, conversations](https://news.microsoft.com/features/microsofts-ai-vision-rooted-in-research-conversations/#yAYKtrYjvRHKCYmc.97)  
-[Bot Framework documentation](https://docs.microsoft.com/bot-framework/)  
+[Bot Framework documentation](/bot-framework)  
 [Responsible bots: 10 guidelines for developers of conversational AI](https://www.microsoft.com/en-us/research/publication/responsible-bots/)  
diff --git a/styleguide/chatbots-virtual-agents/structural-technical-considerations.md b/styleguide/chatbots-virtual-agents/structural-technical-considerations.md
@@ -1,5 +1,6 @@
 ---
 title: Structural and technical considerations - Microsoft Style Guide
+description: Discusses clarify intent before acting, on structural and technical considerations, until you're sure your bot can reliably interpret conversational cues.
 author: pallep
 ms.author: pallep
 ms.date: 02/21/2019

diff --git a/styleguide/chatbots-virtual-agents/writing-bots.md b/styleguide/chatbots-virtual-agents/writing-bots.md
@@ -1,5 +1,6 @@
 ---
 title: Writing for bots - Microsoft Style Guide
+description: Discusses writing for bots and to be friendly while helping to complete the task, such as tailoring the tone of the bot's response to the context.
 author: pallep
 ms.author: pallep
 ms.date: 02/21/2019

diff --git a/styleguide/content-planning.md b/styleguide/content-planning.md
@@ -1,5 +1,6 @@
 ---
 title: Content planning - Microsoft Style Guide
+description: Discusses content planning and how great content starts with a plan that begins with questions, such as who is your audience?
 author: pallep
 ms.author: pallep
 ms.date: 07/31/2018

diff --git a/styleguide/design-planning.md b/styleguide/design-planning.md
@@ -1,5 +1,6 @@
 ---
 title: Design planning - Microsoft Style Guide
+description: Discusses design planning, such as design is more than a pretty face because it provides a familiar environment for content.
 author: pallep
 ms.author: pallep
 ms.date: 01/19/2018

diff --git a/styleguide/developer-content/code-examples.md b/styleguide/developer-content/code-examples.md
@@ -1,5 +1,6 @@
 ---
 title: Code examples - Microsoft Style Guide
+description: Describes code examples, which illustrate how to use a programming element to implement specific functionality. 
 author: pallep
 ms.author: pallep
 ms.date: 08/7/2019

diff --git a/styleguide/developer-content/formatting-developer-text-elements.md b/styleguide/developer-content/formatting-developer-text-elements.md
@@ -1,5 +1,6 @@
 ---
 title: Formatting developer text elements - Microsoft Style Guide
+description: Discusses formatting developer text elements that is consistent text formatting that helps readers locate and interpret information.
 author: pallep
 ms.author: pallep
 ms.date: 08/8/2019

diff --git a/styleguide/developer-content/index.md b/styleguide/developer-content/index.md
@@ -1,5 +1,6 @@
 ---
 title: Developer content - Microsoft Style Guide
+description: Discusses content for developers and IT professionals as more technical than a general audience, but the fundamentals of the Microsoft brand voice still apply.
 author: pallep
 ms.author: pallep
 ms.date: 08/6/2019

diff --git a/styleguide/developer-content/reference-documentation.md b/styleguide/developer-content/reference-documentation.md
@@ -1,5 +1,6 @@
 ---
 title: Reference documentation - Microsoft Style Guide
+description: Discusses reference documentation as providing details about the programming elements associated with technologies and languages, including class libraries.
 author: pallep
 ms.author: pallep
 ms.date: 08/7/2019
@@ -50,7 +51,7 @@ articles. Sections vary depending on the language, product, or technology being
 |   **Declaration/syntax**   |                                                                                                                                                                          The code signature that defines the element. This section might also provide usage syntax. If the technology can be used with multiple programming languages, provide syntax for each language. <br />**Example**<br />`Record.MoveRecord (Source, Destination, UserName, Password, Options, Async)`                                                                                               |
 |       **Parameters**       | If the element has parameters, provide a description of each parameter and its data type. If appropriate, indicate whether the parameter is required or optional and whether it represents input or output. Provide as much useful detail as possible. Don't just repeat the words in the parameter name or the data type.<br />**Examples**<br />*Source*<br />Optional. A **String** value that contains a URL identifying the **Record** to be moved. If *Source* is omitted or specifies an empty string, the object represented by this **Record** is moved. For example, if the **Record** represents a file, the contents of the file are moved to the location specified by *Destination.*<br /><br />*Destination*<br />Optional. A **String** value that contains a URL specifying the location where *Source* will be moved.<br /><br />*UserName*<br />Optional. A **String** value that contains the user ID that, if needed, authorizes access to *Destination.*<br /><br />*Password*<br />Optional. A **String** that contains the password that, if needed, verifies *UserName.*<br /><br />*Options*<br />Optional. A **MoveRecordOptionsEnum** value whose default value is **adMoveUnspecified**. Specifies the behavior of this method.<br /><br />*Async*<br />Optional. A **Boolean** value that, when **True**, specifies this operation should be asynchronous.                                                             |
 |      **Return value**      |                                                                                                                                                                               If the element returns a value, describe the value and information about its data type. If the value is a Boolean that indicates the presence of a condition, describe the condition. <br />**Example**<br />A **String** value. Typically, the value of *Destination* is returned. However, the exact value returned is provider-dependent.                                                                                                                                                                              |
-|        **Remarks**         |                                                                                                                               Additional information about the element and important details that may not be obvious from its syntax, parameters, or return value. For example, you might explain what the element does in more detail, compare it with similar elements, and identify potential issues in its use. <br />**Example**<br />The values of *Source* and *Destination* must not be identical; otherwise, a runtime error occurs. At least the server, path, and resource names must differ.<br /><br />For files moved using the Internet Publishing Provider, this method updates all hypertext links in files being moved unless otherwise specified by *Options.* This method fails if *Destination* identifies an existing object (for example, a file or directory), unless **adMoveOverWrite** is specified.<br /><br />**Note** Use the **adMoveOverWrite** option judiciously. For example, specifying this option when moving a file to a directory will delete the directory and replace it with the file.<br /><br />Certain attributes of the **Record** object, such as the **ParentURL** property, won't be updated after this operation completes. Refresh the **Record** object's properties by closing the **Record**, then reopening it with the URL of the location where the file or directory was moved.<br /><br />If this **Record** was obtained from a **Recordset**, the new location of the moved file or directory won't be reflected immediately in the **Recordset**. Refresh the **Recordset** by closing and reopening it.<br /><br />**Note** URLs using the http scheme will automatically invoke the Microsoft OLE DB Provider for Internet Publishing. For more information, see [Absolute and Relative URLs](https://docs.microsoft.com/sql/ado/guide/data/absolute-and-relative-urls?view=sql-server-2017).                                                                                                                               |
+|        **Remarks**         |                                                                                                                               Additional information about the element and important details that may not be obvious from its syntax, parameters, or return value. For example, you might explain what the element does in more detail, compare it with similar elements, and identify potential issues in its use. <br />**Example**<br />The values of *Source* and *Destination* must not be identical; otherwise, a runtime error occurs. At least the server, path, and resource names must differ.<br /><br />For files moved using the Internet Publishing Provider, this method updates all hypertext links in files being moved unless otherwise specified by *Options.* This method fails if *Destination* identifies an existing object (for example, a file or directory), unless **adMoveOverWrite** is specified.<br /><br />**Note** Use the **adMoveOverWrite** option judiciously. For example, specifying this option when moving a file to a directory will delete the directory and replace it with the file.<br /><br />Certain attributes of the **Record** object, such as the **ParentURL** property, won't be updated after this operation completes. Refresh the **Record** object's properties by closing the **Record**, then reopening it with the URL of the location where the file or directory was moved.<br /><br />If this **Record** was obtained from a **Recordset**, the new location of the moved file or directory won't be reflected immediately in the **Recordset**. Refresh the **Recordset** by closing and reopening it.<br /><br />**Note** URLs using the http scheme will automatically invoke the Microsoft OLE DB Provider for Internet Publishing. For more information, see [Absolute and Relative URLs](/sql/ado/guide/data/absolute-and-relative-urls).                                                                                                                              |
 |        **Example**         |                                                                                                                                                                                       A code example that illustrates how to use the programming element. For more information about writing useful code examples, see [Code examples](./code-examples.md).                                                                                                                                                                                       |
 |      **Requirements or Applies to**      |                                                                                                                                                                                                                                             Language or platform requirements for using the element.<br />**Example**<br />Record Object (ADO)                                                                                          |
 |        **See also**        |                                                                                                                                                     References or links to more information about how to use the element. References or links to related elements.<br />**Examples**<br />Move Method (ADO)<br />MoveFirst, MoveLast, MoveNext, and MovePrevious Methods (ADO) <br />MoveFirst, MoveLast, MoveNext, and MovePrevious Methods (RDS)                                                                                                                                    |
@@ -71,4 +72,4 @@ If you automatically generate reference documentation and comments from the sour
 quality and appropriateness of the comments. Developers might leave out details that are important to 
 customers. Remove any implementation or internal details that aren't suitable for documentation.  
 
-**Learn more** For other examples of technical reference articles, see the [.NET API Browser](https://docs.microsoft.com/dotnet/api/?view=netframework-4.7.1) section of [Microsoft Docs](https://docs.microsoft.com/).
+**Learn more** For other examples of technical reference articles, see the [.NET API Browser](/dotnet/api/?view=netframework-4.7.1&preserve-view=true) section of [Microsoft Docs](/documentation).