Skip to content

Commit ed1344a

Browse files
committed
🐞 improve readability (acrolyix score)
1 parent 700b3f2 commit ed1344a

7 files changed

+36
-38
lines changed

docs/design/authoring-pages.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,7 @@ ms.localizationpriority: high
77

88
# Authoring pages in a SharePoint site
99

10-
Authoring pages in SharePoint is a simple process, but it does require some familiarity with the SharePoint environment, as well as an understanding of what and who you are designing the page for. A few basic principles, such as remembering to "Start simple" and "Build on what's working," are valuable things to consider as you start authoring. It's also a good idea to consistently remind yourself of your audience and the goals that you are trying to help them achieve.
11-
12-
<!-- Do we have content about the design principles that we can link to here? -->
10+
Authoring pages in SharePoint is a simple process, but it does require some familiarity with the SharePoint environment, and an understanding of what and who you are designing the page for. A few basic principles, such as remembering to "Start simple" and "Build on what's working," are valuable things to consider as you start authoring. It's also a good idea to consistently remind yourself of your audience and the goals that you're trying to help them achieve.
1311

1412
The SharePoint page authoring experience has two modes:
1513

@@ -72,7 +70,7 @@ After the page is published, all editing UI is disabled for the viewer or reader
7270

7371
## Mobile view
7472

75-
All SharePoint pages are [responsive](grid-and-responsive-design.md) to allow the content of the page to be viewed on mobile devices. While designing a web part, it is important to understand how the new SharePoint site pages render across different devices.
73+
All SharePoint pages are [responsive](grid-and-responsive-design.md) to allow the content of the page to be viewed on mobile devices. While designing a web part, it's important to understand how the new SharePoint site pages render across different devices.
7674

7775
![Mobile view of site](../images/design-authoring-mobile.png)
7876

docs/design/reactive-and-nonreactive-web-parts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Reactive web parts are fully client-side web parts. This means that each compone
1717

1818
## Nonreactive web parts
1919

20-
Nonreactive web parts are not fully client-side; generally, one or more properties need to make a call to set/pull or store data on a server. For nonreactive web parts, you should enable the **Apply** button at the bottom of the property pane.
20+
Nonreactive web parts aren't fully client-side; generally, one or more properties need to make a call to set/pull or store data on a server. For nonreactive web parts, you should enable the **Apply** button at the bottom of the property pane.
2121

2222
You can also customize the **Apply** button to be a more specific action.
2323

docs/design/ui-text-for-web-parts.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ ms.localizationpriority: medium
77

88
# UI text guidelines for SharePoint web parts
99

10-
One aspect of creating effective web parts in SharePoint is to use simple, understandable, and concise UI text. By keeping your message clear and easy to understand, you ensure that customers move through your experiences quickly and can identify the content they are looking for. This article provides guidance for writing UI text for key areas within SharePoint web parts.
10+
One aspect of creating effective web parts in SharePoint is to use simple, understandable, and concise UI text. By keeping your message clear and easy to understand, you ensure that customers move through your experiences quickly and can identify the content they're looking for. This article provides guidance for writing UI text for key areas within SharePoint web parts.
1111

1212
## Capitalization
1313

@@ -27,12 +27,12 @@ Always capitalize:
2727

2828
Follow the basic rules of punctuation to avoid grammatical errors in your experience. The following table provides guidance and reminders about what punctuation to use when, and why.
2929

30-
|Punctuation |Guidance |Example |
31-
|-------------|------------------------------------------------|-----------------|
32-
|Colons (:) | Use colons if you are introducing a list in the web part description.<br/>Don't use colons in UI labels.| Choose one of the following: Cats, Dogs, Quokkas |
33-
|Commas (,) | Use serial commas (including before the word "and"). |I like cats, birds, and dogs. |
34-
|Ellipses (…)| Use ellipses to show truncation and for progress indicator strings.<br/>Don't use ellipses to indicate that the user must make further choices.|Truncation: Last modified by John Armstr…<br/>Progress indicator: Uploading… |
35-
|Periods (.) | Use periods as you normally would for descriptions.<br/>Don't use periods in titles, headings, or labels. Don't use periods for radio button options or check boxes. | Select the content that you want to highlight and how you want it displayed. Use a filter to narrow your selection. |
30+
| Punctuation | Guidance | Example |
31+
| ------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
32+
| Colons (:) | Use colons if you're introducing a list in the web part description.<br/>Don't use colons in UI labels. | Choose one of the following: Cats, Dogs, Quokkas |
33+
| Commas (,) | Use serial commas (including before the word "and"). | I like cats, birds, and dogs. |
34+
| Ellipses (…) | Use ellipses to show truncation and for progress indicator strings.<br/>Don't use ellipses to indicate that the user must make further choices. | Truncation: Last modified by John Armstr…<br/>Progress indicator: Uploading… |
35+
| Periods (.) | Use periods as you normally would for descriptions.<br/>Don't use periods in titles, headings, or labels. Don't use periods for radio button options or check boxes. | Select the content that you want to highlight and how you want it displayed. Use a filter to narrow your selection. |
3636

3737
## Voice and tone
3838

@@ -41,11 +41,11 @@ Crafting the right tone in your product communication is essential to building a
4141
### Do
4242

4343
- Use a casual, conversational tone in the UI.
44-
- Use contractions. For example, use "can't" instead of "cannot".
44+
- Use contractions. For example, use "can't" instead of "can't".
4545
- Read your UI text out loud to test the tone. Does it sound like everyday language?
4646
- Use simple words.
4747
- Remove technical details if they're not relevant to the user experience.
48-
- Use "Please" only if you are inconveniencing the user. Avoid overuse.
48+
- Use "Please" only if you're inconveniencing the user. Avoid overuse.
4949
- Use "Sorry" only in error messages in SharePoint that result in serious problems for the customer.
5050

5151
### Don't

docs/solution-guidance/Personalize-search-results-sample-app-for-SharePoint.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ In default.aspx.cs, choosing **Perform Personalized Search** calls the **btnPers
6464

6565
- Uses **PeopleManager** to get all user profile properties for the user running this add-in.
6666

67-
- Retrieves and checks the value of the **AboutMe** user profile property. If the value of the **AboutMe** property is **AppTest**, the search query retrieves all sites by using the query string `contentclass:"STS_Site"`. If the value of the **AboutMe** property is not **AppTest**, the team site filter is appended to the query string (`WebTemplate=STS`), and the search query retrieves team sites only.
67+
- Retrieves and checks the value of the **AboutMe** user profile property. If the value of the **AboutMe** property is **AppTest**, the search query retrieves all sites by using the query string `contentclass:"STS_Site"`. If the value of the **AboutMe** property isn't **AppTest**, the team site filter is appended to the query string (`WebTemplate=STS`), and the search query retrieves team sites only.
6868

6969
- Calls the **ProcessQuery** method to retrieve the search results based on the supplied query string. **ProcessQuery** also demonstrates how to specify a list of properties to return with the search results.
7070

docs/solution-guidance/Read-or-update-user-profile-properties-sample-app-for-SharePoint.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@ Scenario 3 shows how to update a multivalued user profile property. The followin
153153
To add new skills to the **SPS-Skills** user profile property from this add-in:
154154

155155
1. Enter HTML5, and then choose **Add Skill**.
156-
1. Enter ASP.Net, and then choose **Add Skill**.
156+
1. Enter ASP.NET, and then choose **Add Skill**.
157157
1. Choose **Run scenario 3**.
158158
1. Verify that **Skills current value** shows the new list of skills for the user.
159159
1. Verify that the **SPS-Skills** user profile property for the user now shows the new list of skills.

0 commit comments

Comments
 (0)