Skip to content

Commit 043ed2d

Browse files
authored
Update nf-style-guide.md
jens comments
1 parent c3e8172 commit 043ed2d

File tree

1 file changed

+16
-12
lines changed

1 file changed

+16
-12
lines changed

nf-style-guide.md

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# NetFoundry style guide
22

3-
This guide is the single source of truth for how we communicate at NetFoundry. Whether you're writing a quick how-to
4-
guide, an in-depth reference, UI content, or a blog post, our documentation is a direct reflection of our brand's
5-
intelligence and reliability. Consistency in tone, voice, and style is not just a matter of good grammar; it's a vital
6-
part of the user experience. When our docs are consistent, they're easier to read, faster to scan, and they build user
7-
trust.
3+
This guide is the single source of truth for all technical content and user-facing documentation at NetFoundry. Whether
4+
you're writing a quick how-to guide, an in-depth reference, UI content, or a blog post, our documentation is a direct
5+
reflection of our brand's intelligence and reliability. Consistency in tone, voice, and style is not just a matter of
6+
good grammar; it's a vital part of the user experience. When our docs are consistent, they're easier to read, faster to
7+
scan, and they build user trust.
88

99
## TL;DR
1010

@@ -116,13 +116,17 @@ The exact top-level buckets we use for the ToC can vary depending on the product
116116
- Don't use "the button". Say "Click **Next**."
117117
- Tell the user to *click* UI items. If it's a drop-down, use *select*.
118118

119-
## Images and file names
119+
## Images and File Names
120120

121-
- A significant amount of readers are on mobile. Don't use images wider than 600-700 px. Shrink browsers for screenshots.
122-
Check the site on your phone.
123-
- Avoid spaces in file names. Descriptive filenames in kebab-case (alphanumeric, lowercase, and with hyphens to seperate
124-
words) is preferable.
125-
- Give images a descriptive alt text.
121+
- A significant amount of readers are on mobile. Don't use images wider than 600-700 px. Shrink browsers for
122+
screenshots.
123+
- Check the site on your phone. Alternatively, use Chrome DevTools:
124+
- Open your documentation page in Chrome.
125+
- Open DevTools (**F12** or **Ctrl+Shift+I** / **Cmd+Option+I**).
126+
- Click the **Toggle device toolbar** icon (it looks like a phone and tablet) in the upper-left corner of the DevTools
127+
window.
128+
- Use the dropdown menu at the top of the viewport to select a common mobile device (e.g., iPhone SE) or enter the
129+
target width manually (e.g., 414px). This simulates the mobile viewing environment.
126130

127131
## Word choices
128132

@@ -145,7 +149,7 @@ Use them. Only use "Note:" if you have to include it somewhere an admonition can
145149
## Spacing
146150

147151
- Use *one* space after periods before the next word.
148-
- Use line spaces between headers and paras, and when introducing elements like tables or lists.
152+
- Use line spaces between headers and paragraphs, and when introducing elements like tables or lists.
149153
- Line spacing helps make Markdown more readable.
150154
- Establish a hard line limit of 120 characters for all body text lines in Markdown topics to improve readability on
151155
large screens and adhere to code formatting standards. To set this, go to VS Code settings, search for `editor ruler`,

0 commit comments

Comments
 (0)