Documentation
Primer documentation should express the voices and contributions of different people, but for it to be useful it’s important to be consistent in tone and structure.
Please read and follow these guidelines carefully when writing documentation, so that as many people as possible can benefit from Primer.
A large proportion of readers want to find an answer that helps them complete a task, so don't waste their time with unnecessary words. That doesn't mean talking like a robot though: a sprinkling of humor is fine as long as it doesn't make the documentation harder to parse or distract from instructions.
Avoid using phrases or referencing examples that are only familiar internally at GitHub. Assume readers are either members of the public or new to GitHub.
Code examples should promote what we'd like to see used in production. People copy and paste code examples as a starting point for building interfaces, and/or reference the guidelines for examples of correct implementation. While examples might be simpler than what we'd use in production, the code should promote best practices and follow our principles and accessibility standards.
Primer documentation is primarily aimed at GitHub designers and engineers at various levels of experience, but folks in other areas will also benefit from and use the guidelines.
Do:
- In design docs, assume the reader knows basic design concepts and principles, such as the need for consistency, and terms such as “white space” or “scale”.
- When referring to GitHub-specific terminology, link to a glossary of terms, or another document where the reader can learn more.
- When referring to terms and ideas the reader may want to know more about, link to authoritative sources, such as MDN and the W3C.
- In non-engineering docs, use code examples as necessary to ensure consistency and appropriate usage, but don't assume expertise in any programming language.
Don’t:
- Don’t assume the reader knows about internal GitHub terminology.
- Write as you speak, then tidy it up.
- Write affirmative sentences wherever possible.
- Be clear and concise.
- Use imperative mood, so that instructions are clear.
- Remove unnecessary words, like adverbs, and keep sentences and paragraphs short.
- Don’t sound like a robot or too formal.
- Don’t use sarcasm or irony, they may not translate well.
- Avoid double negatives.
- Avoid using expressions like “easy”, “simply”, “quick”, “just”.
- Avoid idioms, they can be hard to understand and translate.
- Do: “As a general rule”
- Don’t: “As a rule of thumb”
- Don't use the passive voice to avoid using the word “you” (but remove it if unnecessary).
- Do: “Open Figma”, “Submit an issue if you find a bug”
- Don’t: “Figma can be opened”, “You can open Figma”, “If a bug is found, submit an issue”
- Avoid the possessive "our", and avoid addressing Primer as "our design system”.
- Do: “In the Figma library…”
- Don’t: “In our Figma library…”
- Use "we" consistently to refer to the Design Systems / Infrastructure team, not to GitHub as a whole.
Follow the GitHub content guidelines (this link is only accessible to GitHub staff), in particular:
- Follow US spelling.
- Do: “Color palette”
- Don’t: “Colour palette”
- Use sentence case for titles.
- Do: “Utility classes”
- Don’t: “Utility Classes”
- Capitalize only proper nouns and product names (this link is only accessible to GitHub staff).
- Do: “Open a pull request"
- Don't: "Open a Pull Request"
- Avoid positional language.
- Do: “The list that follows”
- Don’t: “The list below”
- Use contractions.
- Do: “Don’t use this class”, “We’re happy to see you!”
- Don’t: “Do not use this class”, “We are happy to see you.”
- Exclamation points are OK, in moderation.
You may also refer to the content style guide for GitHub Docs, in specific:
Use this Figma template (accessible to GitHub staff only) to create images that are consistent across Primer documentation.
When creating images with example UI for docs make sure that:
- All documentation examples should be of real github.com examples
- Examples only include the most important part of the UI, and don't try to show the entire UI
- Use meaningful copy (for example, use "New issue" instead of "Button" as the text inside a button)
- If mentioning or referring to other styles and documentation, always link to the source.
- Reference an existing guide by linking to it, rather than duplicating the content. However, if this makes the documentation harder to follow, consider providing that reference in the document itself (for example: spacing scale, abbreviations).
- Spellcheck text with an automated tool
- Spellcheck UI text in image examples
- Ask someone else to proofread the document including images - they may catch something you missed
- Test all the links
- Indicate links that only work for GitHub staff (for example, "for GitHub staff only", or "only accessible to GitHub staff")
- Verify there isn’t any private or sensitive information
- Verify that all images include an alt text
When documenting components, consider the core elements needed to convey its main purpose and proper usage within the UI.
Use sentence case when referring to component names. Do not capitalize the component in the middle of a sentence.
- Do: It's recommended to always show a heading to give users a permanent description of the comment box.
- Don't: It's recommended to always show a heading to give users a permanent description of the Comment box.
When writing the component description, introduce the component directly, without "a" or "an":
- Do: Action menu is a component based on action list for creating a menu of actions that expands through a trigger button.
- Don't: An action menu is a component based on action list for creating a menu of actions that expands through a trigger button.
The description appears directly under the title of the component. It may be automatically pulled from component-metadata, and can be edited as needed.
- What is this component, and how would you describe it to someone who has never used it before? This description should be concise and shouldn't include usage information, which is covered below this section.
- When to use this component
- Best practices
- Do/Don't examples
- Describe the elements that make up the component, including typography, spacing, and styles. This can also include sub components, if there are any. See Action list as an example.
- Different sizes, typography options, layout variations, spacing, etc.
- Different applications of the component in context
- If there are specific behaviors or interactions that the consumer of this documentation should be aware of, it's important to document here. Is it clickable, or static, and does it have any specific interactions based on state? Are there multiple types of behavior, and when does each get applied? See Autocomplete as an example.
Any component-specific accessibility considerations should be documented. This could include keyboard navigation, touch targets, and any specific usage guidelines with regards to assistive technology. See Segmented control.
If there are any accessibility issues that need to be addressed, but are not yet resolved, they should be documented here as well.
Known issues: Add a "Known issues" section that links to all GitHub issues that are labeled with both the accessibility label and the component: name label. See example below.
Step 1. Import the component at the top of the file:
import {AccessibilityLink} from '~/src/components/accessibility-link'
Step 2. Add section to the markdown content under the Accessibility heading. If there is no Accessiblity section, you will need to add one:
## Accessibility
### Known accessibility issues (GitHub staff only)
<AccessibilityLink label="Truncate"/>
Any components or patterns that you may want to reference as related to this component. This could include components that are similar, or components that are used in conjunction with this component. See Autocomplete as an example.
One of the strategies to help Primer documentation become self-serve is to accurately represent the breadth of patterns and components we have available through our documentation.
To do this, we are increasing our coverage to include 100% of available-for-use components temporarily in the primer/design repository. Executing on this plan requires us to be practical and concise in terms of the depth of the documentation. In order to ensure we can reach 100% coverage, we're using a "minimum-viable documentation" approach.
Minimum-viable documentation should be:
- Accurate
- Informative but concise
- Visible
Aside from components we deem to be high touch and therefore requiring more in-depth documentation, the majority of components that are missing usage guidelines will be documented with the following minimum requirements:
- brief text describing what the component is
- link to available implementations
- image, if applicable
- proper usage guides
- visual examples, such as an image or gif demonstrating what the component is
If more information (than required above) is easily accessible and doesn't require a huge time investment to include, it should be added to to the minimum-viable component documentation. Some examples of this include listing out related components, cross-linking to Accessibility guidelines, and more.
- A great starting off point is to consolidate existing documentation for the component that's already available. Places to look:
- Work in pairs or with a small group. Dedicate 1-2 components per person, with each person in the group responsible for reviewing the others' PRs.
- Timebox each component to x hour(s) for writing, x hour(s) for reviewing, and x hour(s) for writing revisions.
- If you feel blocked by a lack of information about the component to write useful documentation, move on to documenting a different component until we can get the context we need.
All pull requests for new and updated guidelines should be reviewed and approved by a member of the Design Infrastructure team.