* Renaming files and a lot of find and replace * pageRank meta tags, sorting by page rank * reranking * removing numbers * revert changing links that are locked to a commit * update metatag name, uncomment github contributers * Update basic-documentation.page.js * revert link change * more explicit errors, change pageOrderInSection numbers, updated sort * Update build-static-content.js * update comment * update handbook link * handbook entry * update sort * update changelog doc links to use fleetdm.com * move standard query library back to old location, update links/references to location * revert unintentional link changes * Update handbook/community.md Co-authored-by: Mike Thomas <78363703+mike-j-thomas@users.noreply.github.com> Co-authored-by: Mike Thomas <78363703+mike-j-thomas@users.noreply.github.com> Co-authored-by: Mike McNeil <mikermcneil@users.noreply.github.com>
6.6 KiB
Brand
Communicating as Fleet
-
Sound positive, and assume positive intent. A positive tone helps to empower our users and encourages them to succeed with Fleet.
-
Be relatable, friendly and sincere. Being relatable reminds our users that they're talking to another human that cares. Use simple words and sentences, especially in technical conversations.
-
Project confidence, and be informative. Clearly tell users what they need to know, remembering to always stay positive so as NOT to sound overconfident.
-
Manage risk, not fear. Educate users about security threats positively. Risk management is smart, but focusing on fear can lead to poor decisions. We NEVER use fear as a communication and marketing tactic.
-
Consider the meaning of words. We never want to offend people or sound judgemental. Industry jargon that was once commonly used may now be considered offensive and should be avoided.
What would Mr Rogers say?
At Fleet, our voice and tone should be clear, simple, friendly, and inspiring - like Mr. Rogers who had a deep understanding of these communication values.
Consider the example tweets below. What would Mr. Rogers say?
Distributed workforces aren’t going anywhere anytime soon. It’s past time to start engaging meaningfully with your workforce and getting them to work with your security team instead of around them.
becomes...
Distributed workforces aren’t going anywhere anytime soon, so it’s a great time to engage with your crew and help them to work with your security team instead of around them.
By Mr Rogering our writing we can emphasize positivity, optimism and encourage our readers to succeed. The example above also considers sentence flow and use of synonyms to reduce repetition.
Another example to consider is industry jargon that may now be inappropriate. While the term "responsible vulnerability disclosure" has been used for decades, it supposes that people who use a different process are irresponsible. Using coordinated disclosure is a more positive way to discuss the issue.
Voice and tone guidelines
How to use our name
When talking about Fleet the company, we stylize our name as either "Fleet" or "Fleet Device Management". For Fleet the product, we say either “Fleet” or “Fleet for osquery”.
How to write headings & subheadings
Fleet uses sentence case capitalization for all headings across Fleet EE, fleetdm.com, our documentation, and our social media channels. In sentence case, we write titles as if they were sentences. For example:
Ask questions about your servers, containers, and laptops running Linux, Windows, and macOS
As we are using sentence case, only the first word of a heading and subheading is capitalized. However, if a word in the sentence would normally be capitalized (e.g. a proper noun,) these words should also be capitalized in the heading.
Note the capitalization of “macOS” in the example above. Although this is a proper noun, macOS uses its own style guide from Apple, that we adhere to.
How use osquery in sentences and headings
Osquery should always be written in lowercase, unless used to start a sentence or heading. For example:
Open source software, built on osquery.
or
Osquery and Fleet provide structured, convenient access to information about your devices.
Brand resources
To download official Fleet logos, product screenshots, and wallpapers, head over to our brand resources page.
See also https://fleetdm.com/handbook/community#press-releases for our press-release boilerplate.
Fleet website
How to export images
In Figma:
- Select the layers you want to export.
- Confirm export settings and naming convention:
- item name - color variant - (css)size - @2x.fileformat (e.g.,
os-macos-black-16x16@2x.png
) - note that the dimensions in the filename are in CSS pixels. In this example, the image would actually have dimensions of 32x32px, if you opened it in preview. But in the filename, and in HTML/CSS, we'll size it as if it were 16x16. This is so that we support retina displays by default.
- File extension might be .jpg or .png.
- Avoid using SVGs or icon fonts.
- Click the Export button.
When can I merge a change to the website?
When merging a PR to master, bear in mind that whatever you merge to master gets deployed live immediately. So if the PR's changes contain anything that you don't think is appropriate to be seen publicly by all guests of fleetdm.com, then please do not merge.
Merge a PR (aka deploy the website) when you think it is appropriately clean to represent our brand. When in doubt, use the standards and level of quality seen on existing pages, ensure correct functionality, and check responsive behavior - starting widescreen and resizing down to ≈320px width.
The "Deploy Fleet Website" GitHub action failed
If the action fails, please complete the following steps:
- Head to the fleetdm-website app in the Heroku dashboard and select the "Activity" tab.
- Select "Roll back to here" on the second to most recent deploy.
- Head to the fleetdm/fleet GitHub repository and re-run the Deploy Fleet Website action.
Browser compatibility checking
A browser compatibility check of fleetdm.com should be carried out monthly to verify that the website looks, and functions as expected across all supported browsers.
- We use BrowserStack (logins can be found in 1Password) for our cross-browser checks.
- Check for issues against the latest version of Google Chrome (macOS). We use this as our baseline for quality assurance.
- Document any issues in GitHub as a bug report, and assign for fixing.
- If in doubt about anything regarding design or layout, please reach out to the Design team.