Skip to content

Commit 69f1709

Browse files
authored
Improve clarity and conciseness in Best practices for GitHub Docs article
This PR improves clarity, conciseness, and flow in the "Best practices for GitHub Docs" article. Changes include: - Reducing repetition - Simplifying sentence structure - Improving readability and scannability - Minor wording improvements for clarity The structure and meaning remain unchanged.
1 parent 4af4649 commit 69f1709

File tree

1 file changed

+39
-36
lines changed

1 file changed

+39
-36
lines changed

content/contributing/writing-for-github-docs/best-practices-for-github-docs.md

Lines changed: 39 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Best practices for GitHub Docs
33
shortTitle: Best practices for GitHub Docs
4-
intro: Follow these best practices to create documentation that's user-friendly and easy to understand.
4+
intro: Follow these best practices to create documentation that is user-friendly, clear, and easy to understand.
55
versions:
66
fpt: '*'
77
ghec: '*'
@@ -10,17 +10,17 @@ versions:
1010

1111
## About {% data variables.product.prodname_dotcom %} documentation
1212

13-
At {% data variables.product.prodname_dotcom %}, we strive to create documentation that is accurate, valuable, inclusive, accessible, and easy to use.
13+
At {% data variables.product.prodname_dotcom %}, we aim to create documentation that is accurate, valuable, inclusive, accessible, and easy to use.
1414

15-
Before contributing to {% data variables.product.prodname_docs %}, please take a moment to familiarize yourself with {% data variables.product.prodname_dotcom %}'s documentation philosophy, fundamentals, and content design principles:
15+
Before contributing to {% data variables.product.prodname_docs %}, review {% data variables.product.prodname_dotcom %}'s documentation philosophy, fundamentals, and content design principles:
1616

1717
* [AUTOTITLE](/contributing/writing-for-github-docs/about-githubs-documentation-philosophy)
1818
* [AUTOTITLE](/contributing/writing-for-github-docs/about-githubs-documentation-fundamentals)
1919
* [AUTOTITLE](/contributing/writing-for-github-docs/content-design-principles)
2020

2121
## Best practices for writing {% data variables.product.prodname_dotcom %} documentation
2222

23-
Whether you're creating a new article or updating an existing one, you should follow these guidelines when writing for {% data variables.product.prodname_docs %}:
23+
When creating or updating an article, follow these guidelines:
2424

2525
* [Align content to user needs](#align-content-to-user-needs)
2626
* [Structure content for readability](#structure-content-for-readability)
@@ -29,21 +29,22 @@ Whether you're creating a new article or updating an existing one, you should fo
2929

3030
## Align content to user needs
3131

32-
Before you begin, it’s important to understand who you’re writing for, what their goals are, the core tasks or concepts that the article will address, and what type of content to write.
32+
Before writing, identify your audience, their goals, and the main tasks or concepts the article will cover.
3333

3434
### Define the audience
3535

36-
* Who will read this content?
37-
* What are they trying to do?
36+
* Who is the intended reader?
37+
* What are they trying to accomplish?
3838

3939
### Define the core purpose
4040

41-
* What should someone be able to do or understand after reading this article? Choose one or two tasks or concepts that the content will discuss.
42-
* If there are additional tasks, concepts, or information that are not essential, consider if they can be placed lower in the article, moved to another article, or omitted completely.
41+
* What should readers be able to do or understand after reading this article?
42+
* Focus on one or two primary tasks or concepts.
43+
* Move secondary information lower in the article, to another article, or remove it if unnecessary.
4344

4445
### Determine the content type
4546

46-
Determine which type of content you will write, based on the intended audience and the core purpose of the content. {% data variables.product.prodname_docs %} use the following content types:
47+
Choose the content type based on your audience and purpose. {% data variables.product.prodname_docs %} supports:
4748

4849
* [Conceptual content](/contributing/style-guide-and-content-model/conceptual-content-type)
4950
* [Referential content](/contributing/style-guide-and-content-model/referential-content-type)
@@ -52,54 +53,56 @@ Determine which type of content you will write, based on the intended audience a
5253
* [Quickstart](/contributing/style-guide-and-content-model/quickstart-content-type)
5354
* [Tutorial](/contributing/style-guide-and-content-model/tutorial-content-type)
5455

55-
For example, use the conceptual content type to help readers understand the basics of a feature or topic and how it can help them accomplish their goals. Use the procedural content type to help people complete a specific task from start to finish.
56+
For example:
57+
- Use conceptual content to explain what a feature does and why it matters.
58+
- Use procedural content to guide readers through completing a specific task.
5659

5760
## Structure content for readability
5861

59-
Use the following best practices to structure the content. When adding content to an existing article, follow the existing structure whenever possible.
62+
When adding content to an existing article, follow its structure whenever possible.
6063

61-
* **Provide initial context**. Define the topic and state its relevance to the reader.
62-
* **Structure the content in a logical order** by importance and relevance. Place information in order of priority, and in the order users will need it.
63-
* **Avoid long sentences and paragraphs**.
64-
* Introduce concepts one by one.
64+
* **Provide initial context.** Define the topic and explain why it matters.
65+
* **Organize content logically.** Present information in order of importance and in the sequence users need it.
66+
* **Avoid long sentences and paragraphs.**
67+
* Introduce concepts one at a time.
6568
* Use one idea per paragraph.
66-
* Use one idea per sentence.
67-
* **Emphasize the most important information**.
68-
* Begin each sentence or paragraph with the most important words and takeaways.
69-
* When explaining a concept, start with the conclusion, then explain it in more detail. (This is sometimes called an "inverted pyramid.")
70-
* When explaining a complex topic, present readers with the basic information first, and disclose the details later in the article.
71-
* **Use meaningful subheadings**. Organize related paragraphs into sections. Give each section a subheading that is unique and that accurately describes the content.
72-
* **Consider using in-page links** for longer content. This allows readers to jump to areas of interest and skip content that is irrelevant to them.
69+
* Keep sentences focused and concise.
70+
* **Highlight key information.**
71+
* Begin with the most important takeaway.
72+
* When explaining concepts, start with the conclusion, then add supporting details (the “inverted pyramid” approach).
73+
* Present basic information first, then introduce complexity.
74+
* **Use clear, meaningful subheadings.** Ensure each section title accurately reflects its content.
75+
* **Add in-page links for longer articles.** This helps readers navigate directly to relevant sections.
7376

7477
## Write for readability
7578

76-
Make it easy for busy users to read and understand the text.
79+
Help busy readers quickly understand the content.
7780

78-
* **Use plain language.** Use common, everyday words, and avoid jargon when possible. Terms that are well known to developers are fine, but don't assume that the reader knows the details of how {% data variables.product.prodname_dotcom %} works.
81+
* **Use plain language.** Prefer clear, everyday words. Avoid unnecessary jargon.
7982
* **Use active voice.**
8083
* **Be concise.**
81-
* Write sentences that are simple and brief.
82-
* Avoid complex sentences that contain multiple concepts.
83-
* Pare down unnecessary details.
84+
* Write short, direct sentences.
85+
* Avoid combining multiple ideas in one sentence.
86+
* Remove unnecessary detail.
8487

85-
For related information, see "Voice and tone" in [AUTOTITLE](/contributing/style-guide-and-content-model/style-guide#voice-and-tone) and [AUTOTITLE](/contributing/writing-for-github-docs/writing-content-to-be-translated).
88+
For related guidance, see "Voice and tone" in [AUTOTITLE](/contributing/style-guide-and-content-model/style-guide#voice-and-tone) and [AUTOTITLE](/contributing/writing-for-github-docs/writing-content-to-be-translated).
8689

8790
## Format for scannability
8891

89-
Most readers don't consume articles in their entirety. Instead they either _scan_ the page to locate specific information, or _skim_ the page to get a general idea of the concepts.
92+
Most readers scan or skim documentation rather than reading every word.
9093

91-
When scanning or skimming content, readers skip over large chunks of text. They look for elements that are related to their task or that stand out on the page, such as headings, alerts, lists, tables, code blocks, visuals, and the first few words in each section.
94+
When scanning, readers focus on headings, alerts, lists, tables, code blocks, visuals, and the first few words of sections.
9295

93-
Once the article has a clearly defined purpose and structure, you can apply the following formatting techniques to optimize the content for scanning and skimming. These techniques can also help to make content more understandable for all readers.
96+
Once your article has a clear purpose and structure, use these formatting techniques:
9497

95-
* **Use text highlighting** such as boldface and hyperlinks to call attention to the most important points. Use text highlighting sparingly. Do not highlight more than 10% of the total text in an article.
96-
* **Use formatting elements** to separate the content and create space on the page. For example:
97-
* Bulleted lists (with optional run-in subheads)
98+
* **Use text highlighting** (bold text and hyperlinks) to emphasize key points. Use it sparingly—avoid highlighting more than 10% of the article.
99+
* **Use formatting elements** to break up text and create visual structure, such as:
100+
* Bulleted lists
98101
* Numbered lists
99102
* [Alerts](/contributing/style-guide-and-content-model/style-guide#alerts)
100103
* Tables
101104
* Visuals
102-
* Code blocks and code annotations
105+
* Code blocks with annotations
103106

104107
## Further reading
105108

0 commit comments

Comments
 (0)