Adapt content from Status style guide #55
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
cheny0
commented
Sep 16, 2025
| > | ||
| > You can use links in tables except if the table is part of a procedure step. | ||
| Use the following guidelines when using periods in a table for punctuation: |
There was a problem hiding this comment.
Punctuation guidelines edited based on the discussion here: #39
cheny0
commented
Sep 16, 2025
| - When the list items are complete sentences, use a period at the end of each sentence. | ||
| - Don't use a period when the list items are not complete sentences or sentences with three words or less. | ||
| - In a list with elements of more and less than three words mixed, don't use a period. | ||
| - If one item in a column is a complete sentence, all items in that column should end with a period, even if they are a single word. |
There was a problem hiding this comment.
Added this rule based on this discussion: #39
cheny0
commented
Sep 16, 2025
|
|
||
| - When reading instructions, users understand numbered lists as actions to complete orderly. Because of this, limit the numbered lists to procedural instructions in procedure topics. | ||
| - If you must use a numbered list outside of a procedure, use the same rules described for bullet lists. | ||
| - Use "1." for all items in a numbered list. This ensures the list renders correctly and simplifies reordering. |
cheny0
commented
Sep 16, 2025
|
|
||
| - Don't use idioms, colloquial expressions, and culture-specific references. When writing examples to clarify a feature or concept, don't use historical references, brand names, social or political events, or any other topic that might be controversial or meaningless for a global audience. | ||
| - Observe the style rules for [numbers, date and time, currencies and units of measure](./14-numbers-date-and-time-currencies-and-units-of-measure.md). | ||
| - Avoid using *they* to refer to the neutral gender. While this is a perfectly valid rule in English, it may be challenging to interpret by non-native English speakers. |
There was a problem hiding this comment.
Wondering if we should delete this rule. We've used "they" quite a few times
cheny0
commented
Sep 16, 2025
| | **Correct** | Go to **Settings > Messages > Privacy**. | | ||
| | Incorrect | Go to **Settings**, then go to **Messages**, then tap **Privacy**. | | ||
|
|
||
| - Don't describe to users what's happening on the screen, unless the result is unexpected. |
There was a problem hiding this comment.
The content in line 24-42 is from the Status procedure style guide. Because we don't need to emphasize how to describe UI elements in the IFT procedure doc standards, this section is better suited for this content
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
[✅] Admonitions
[✅] Bullet lists
[✅] Capitalization
[✅] Checkbox lists
[x] Contractions - Do we still want to use contractions to make the text more casual?
[✅] Global language
[✅] Iconography
[✅] Links
[✅] Modal verbs
[✅] Numbered lists
[✅] Numbers
[✅] Other conventions
[✅] Possessive form
[✅] Punctuation
[✅] Sentences and paragraphs
[x] Spelling - Oxford spelling doesn't apply here
[✅] Style conventions
[✅] Symbols and punctuation marks
[✅] Tables
[✅] Titles
[✅] UI elements
[✅] Writing style