зеркало из https://github.com/github/docs.git
removing-brand-guide-links (#31879)
This commit is contained in:
Родитель
043e5842ec
Коммит
7f23ed5fc5
|
@ -2,7 +2,7 @@
|
|||
|
||||
Welcome to the content style guide for [GitHub Docs](https://docs.github.com/).
|
||||
|
||||
These guidelines are specific to GitHub’s documentation. For general style questions or guidance on topics not covered here, see the [GitHub Brand Guide](https://brand.github.com/content/) first, then the [Microsoft Style Guide](https://docs.microsoft.com/style-guide/welcome/). For markup specific to source content on docs.github.com, see our [markup reference guide](content-markup-reference.md).
|
||||
These guidelines are specific to GitHub’s documentation. For general style questions or guidance on topics not covered here, see the [Microsoft Style Guide](https://docs.microsoft.com/style-guide/welcome/). For markup specific to source content on docs.github.com, see our [markup reference guide](content-markup-reference.md). For any questions about the GitHub brand, see our "[GitHub Brand Guide](https://brand.github.com)"
|
||||
|
||||
Use table of contents icon <img src="../assets/images/table-of-contents.png" width="25" height="25" /> on the top left corner of this document to get to a specific section of this guide quickly.
|
||||
|
||||
|
@ -165,8 +165,6 @@ Individual words might be small, but together they can create community, belongi
|
|||
|
||||
### Resources about inclusive language
|
||||
|
||||
GitHub Brand Guide:
|
||||
|
||||
The Microsoft Style Guide offers resources on bias-free communication, accessibility terms, and writing for all abilities:
|
||||
- [Bias-free communication](https://docs.microsoft.com/style-guide/bias-free-communication)
|
||||
- [Writing for all abilities](https://docs.microsoft.com/style-guide/accessibility/writing-all-abilities)
|
||||
|
@ -304,8 +302,6 @@ It's not necessary to link to an external product’s website when we mention an
|
|||
|
||||
## Lists
|
||||
|
||||
For general guidelines, see “[Lists](https://brand.github.com/content/grammar#lists)” in GitHub’s Brand Guide.
|
||||
|
||||
Capitalize the first letter in each line of a list. Use periods at the end of lines in a list only if the line contains a complete sentence.
|
||||
|
||||
When writing a list of items that consist of primary and secondary text, such as a `term` and its definition, use a colon delimiter. The secondary text should be capitalized as if it was the beginning of the line. For example:
|
||||
|
@ -349,7 +345,7 @@ Product names are always singular.
|
|||
- **Use:** GitHub Actions helps you automate your software development workflows.
|
||||
- **Avoid:** GitHub Actions help you automate your software development workflows.
|
||||
|
||||
Take care to distinguish between product names and product elements. For more information, see “[Terminology](https://brand.github.com/content/terminology)” in GitHub’s Brand Guide.
|
||||
Take care to distinguish between product names and product elements.
|
||||
|
||||
| Product | Element |
|
||||
| --- | --- |
|
||||
|
@ -452,7 +448,7 @@ Use "development container configuration files" to refer to all of the files in
|
|||
|
||||
## Punctuation
|
||||
|
||||
Follow standard American English punctuation rules. For more guidance, see “[Punctuation](https://brand.github.com/content/grammar#punctuation)” in GitHub’s Brand Guide and “[Punctuation](https://docs.microsoft.com/style-guide/punctuation)” in the Microsoft Style Guide.
|
||||
Follow standard American English punctuation rules. For more guidance, see “[Punctuation](https://docs.microsoft.com/style-guide/punctuation)” in the Microsoft Style Guide.
|
||||
|
||||
## Reusables and variables
|
||||
Use reusable strings for individual nouns (e.g. product names) or for complete sentences or paragraphs. Sentence fragments and phrases should not be contained in reusable strings as they can cause problems when content is localized. For more information, see the [data directory](../data) in the github/docs repository and the “[Product names](#product-names)” section of this document.
|
||||
|
@ -550,9 +546,6 @@ When referencing text in the user interface, reproduce the text exactly. Use quo
|
|||
- **Use:** Under “IP allow list”, click **Edit**.
|
||||
|
||||
### More resources
|
||||
GitHub Brand Guide:
|
||||
- [Referring to GitHub features and product elements](https://brand.github.com/content/terminology/#referring-to-github-features-and-product-elements)
|
||||
- [Page names and UI references](https://brand.github.com/content/grammar#page-names-and-ui-references)
|
||||
Microsoft Style Guide:
|
||||
- [Formatting text in instructions](https://docs.microsoft.com/style-guide/procedures-instructions/formatting-text-in-instructions)
|
||||
|
||||
|
@ -562,7 +555,7 @@ Use clear, simple language that’s approachable and accessible for a wide range
|
|||
|
||||
## Word choice and terminology
|
||||
|
||||
For general guidance and GitHub-specific terms, see “[Terminology](https://brand.github.com/content/terminology)” and “[Words that can be tricky](https://brand.github.com/content/grammar#words-that-can-be-tricky)” in GitHub’s Brand Guide. For more detailed guidance, see the “[A-Z word list](https://docs.microsoft.com/style-guide)” in Microsoft’s style guide.
|
||||
For general guidance and GitHub-specific terms, see our "[Glossary](https://docs.github.com/en/get-started/quickstart/github-glossary)". For more detailed guidance, see the “[A-Z word list](https://docs.microsoft.com/style-guide)” in Microsoft’s style guide.
|
||||
|
||||
### Abbreviations
|
||||
|
||||
|
|
Загрузка…
Ссылка в новой задаче