Skip to content

Commit

Permalink
Changes to rules to formatting new lines and inclusions in related rules
Browse files Browse the repository at this point in the history
  • Loading branch information
joshberman1 committed Mar 27, 2024
1 parent b698f97 commit e9309b0
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 10 deletions.
1 change: 1 addition & 0 deletions categories/communication/rules-to-better-email.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,7 @@ index:
- following-microsoft-365-groups
- description-to-the-group
- highlight-template-differences
- format-new-lines

---

Expand Down
1 change: 1 addition & 0 deletions categories/design/rules-to-better-content-design.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ index:
- distinguish-keywords-from-content
- avoid-repetition
- avoid-full-stops-in-bullet-point-lists
- format-new-lines
---

Content design helps create a frictionless user experience by presenting the right information in the right way and at the right time. This is an application of design thinking principles, improving the ways you structure and present user-oriented content. Effective content leads to better:
Expand Down
25 changes: 15 additions & 10 deletions rules/format-new-lines/rule.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,14 @@
---
type: rule
title: Do you know where to add new lines?
title: Do you enhance readability with line breaks and spacing?
uri: format-new-lines
authors:
- title: Brady Stroud
url: https://ssw.com.au/people/brady-stroud
- title: Adam Cogan
url: https://www.ssw.com.au/people/adam-cogan/
- title: Josh Berman
url: https://www.ssw.com.au/people/josh-berman/
related:
- add-useful-and-concise-figure-captions
- use-the-right-html-figure-caption
Expand All @@ -17,9 +21,15 @@ Sometimes when writing content, you need to make the decision to keep it on the

It is recommended that notes, tips and figures should be on a new line to enable better readability. It can also be beneficial to bold those words.

❗️ Important - Line breaks in web pages (HTML) can be used, but when done to create spacing it becomes a ❌ bad practice!
Learn more: https://blog.hubspot.com/website/html-line-break

When referring to emails and/or informal documents, line breaks can be used for spacing since they are easier than dealing with margins, and we don’t care about syntax.

It is recommended to include spaces after a figure description - in web design, use CSS margins to achieve this.

::: greybox
Good way: use the Dynamics 365 (formerly CRM 2016) toolbar?
**Note:** We have a suggestion that Outlook should allow you to put the CRM2016 URL into Tools | Options so this is better integrated
Test the login functionality thoroughly **Note:** try both valid and invalid credentials
:::
::: bad
Figure: Bad Example - No line break before the note.
Expand Down Expand Up @@ -66,7 +76,7 @@ I will do the IoC after.

:::
::: bad
Figure: Bad Example - No new lines for PBIs.
Figure: Bad Example - No list for spacing PBIs.
:::

::: greybox
Expand All @@ -79,12 +89,7 @@ I will do the IoC after.

:::
::: good
Figure: Good Example - PBIs on a new line.
:::

<!-- TODO: Add CodeAuditor box -->
::: info
This rule is enforced by CodeAuditor. https://codeauditor.com/rules
Figure: Good Example - List is used to space PBIs.
:::

See the [Markdown Guide](https://www.markdownguide.org/basic-syntax/#line-breaks) for more information on line breaks.
Expand Down

0 comments on commit e9309b0

Please sign in to comment.