Help Center writing standards
When writing or editing Help Center articles, use the following standards as guidelines.
The standards are organized in three groups:
Article-level decisions — what kind of article to write, how to title it, how to set its voice
Writing mechanics — formatting, grammar, lists, images, procedures
Audit and rewrite process — how to approach an existing article, when to deprecate, how to validate against source
Article-level decisions
Article scope and discovery
Keep articles short and focused. A reader landing on an article should be able to solve a specific problem or understand a specific concept without scrolling through unrelated content. When an article starts to cover multiple problems, break it down into smaller articles linked from a parent or workflow article.
Short, focused articles are also easier to maintain — when the product changes, the radius of update is smaller.
Three design principles to keep in mind:
Design for busy readers. Most readers want the Solution and won't read the Go deeper. Lead with the answer; defer explanations and alternatives below.
Design for re-use. Readers come back to articles they've already used. Make the Solution scannable and copy-paste friendly so they don't have to re-read the whole article on every return visit.
Design for easy discovery. Readers find articles by keyword search, not by browsing. Use the reader's vocabulary in the title and description, not internal product jargon. If the customer says "SSO" and the product team says "Identity Federation," use SSO.
Article patterns
Three patterns to choose from. Pick the one that matches the article's actual job; don't force cookbook structure onto an orientation or reference article.
Cookbook — Scenario / Solution / Go deeper / See also. For task-oriented articles where a reader has a specific problem to solve. Most "how to" articles fit this. Examples: "How to schedule an event," "Integration for Slack," "How to create and edit an article."
PlusPlus 101 hub — Why X / How it works / Choose / Set up / Operate / See also. For orientation articles that introduce a feature area and route readers to multiple sub-articles. Use when the article's job is navigation, not procedure. The "PlusPlus 101:" prefix is not required for the pattern to apply — what matters is the navigational job. Examples: "PlusPlus 101: SSO Integration," "PlusPlus 101: Getting started with notifications."
Reference / explanation — custom structure (for example, trigger / lifecycle / retention / configuration). For documentation that explains how a system behaves rather than walking through steps. Use when the content is about what happens, not what to do. Examples: deprovisioning lifecycle, scheduled-track Slack channel behavior, user-role definitions.
Family naming, titles, and descriptions
Articles within a feature family use Feature: Subtopic format. This keeps related articles findable in search and signals family membership at a glance.
Examples:
People Integration: SCIM
People Integration: Workday
Scheduled Tracks: Slack channels
User Roles: Restricted Users
Use sentence case for titles (see Formatting, grammar, and word choice below for the general sentence-case rule).
Always include a description under the title. Aim for up to 220 characters. Descriptions appear in Intercom search-result snippets and on article cards, so they should read as concrete, one-sentence summaries of what the article does and who it's for — not as essay intros or marketing copy.
Good descriptions are scannable and lead with the action or behavior.
Examples:
For Integration for Slack: "Set up the PlusPlus Slack integration to deliver notifications as direct messages, configure user matching, and auto-create Slack channels for scheduled tracks."
For Scheduled Tracks: Slack channels: "How PlusPlus auto-provisions Slack channels when you publish a scheduled track — channel naming, enrollee membership, notification defaults, and the permission scopes required."
URL slugs are sticky once published. Treat the article title as the place to apply naming convention; don't break URLs to chase consistency. Inbound links from in-product help, sales collateral, customer bookmarks, and search results all break if a slug changes.
Title and slug can diverge. The title should follow current convention; the slug stays whatever it was originally.
Title (current convention) | URL slug (frozen) |
People Integration: Custom Integration | direct-api |
Scheduled Tracks: Slack channels | scheduled-tracks-slack-channel-integration |
When publishing a renamed article in Intercom, change the title but leave the URL slug untouched.
Voice and tone
Direct and precise, RFP-ready by default. Speak as though you are addressing a respected colleague — not talking down to the reader, but also not padding with pleasantries or marketing copy.
Avoid:
Marketing phrasing: "designed to streamline," "powerful integration," "seamlessly," "robust"
Overview / Conclusion shells unless the article genuinely warrants them
"We" framing that emphasizes the company over the reader's task
A description like "Connect PlusPlus to your Slack workspace to deliver notifications as direct messages" works for RFP grading. "Unlock powerful Slack notifications for your team!" does not.
See Also
The See Also section is a curated short list, not a generic dump. Three to five links is typical. Focus on:
Other articles in the same family (siblings in the
Feature: Subtopicpattern)One or two adjacencies (related families the reader might step into next)
The parent hub or 101 article the article lives under
Do not duplicate links already inline in the article body. Do not include every tangentially-related article.
Example for Integration for Slack:
Scheduled Tracks: Slack channels (sibling)
How to customize email and Slack notifications (adjacency)
Pro tips for customizing notifications (adjacency)
PlusPlus 101: Getting started with notifications (parent hub)
Writing mechanics
Formatting, grammar, and word choice
Generally, our voice and style should not talk down to users, but should feel as though we are speaking to a respected colleague.
Put names of fields, buttons, and so on, in bold text.
Click Start. | YES |
Click "Start". | NO |
Click Start. | NO |
Don't refer to UI elements if possible (like button, field, and so on).
Click Save. | YES |
Click the Save button. | NO |
Don't capitalize items in the UI unless referring to actual fields, buttons, and so on.
To create an event: | YES |
To create an Event: | NO |
Select Add Event. | YES |
Events module | YES |
Events Module | NO |
Use second person when referring to the reader.
You can schedule an event based on an event type. | YES |
The user can schedule an event based on an event type. | NO |
Use present tense verbs, avoiding "will" or "would then."
The menu opens when you click the button. | YES |
The menu will open when you click the button. | NO |
When you click the button, the menu would then open. | NO |
Avoid pleasantries (if desired, please, simply, and so on).
Optionally, re-order the track steps. | YES |
If desired, re-order the track steps. | NO |
Simply re-order the track steps. | NO |
Don't use Latin abbreviations.
Do not use | Do use |
etc. | and so on |
e.g. | for example |
Use sentence case for article titles and headings and title case for UI fields and buttons.
| YES| NO
---|---|---
Article titles| Help Center writing standards| Help Center Writing Standards
Article headings| Go deeper| Go Deeper
UI elements| Select Add Event from the menu. | Select ADD EVENT from the menu.
*even though it is in all caps in the UI
Avoid referring to the "system" or "application" when talking about the instance of PlusPlus the reader is using. If it can't be helped, use "system."
A confirmation dialog appears. | YES |
The system displays a confirmation dialog. | NO |
You select from a list of options and click on a button that takes action.
Select Dashboard from the menu.
Click Bulk Import.
Buttons are clickable, and icons are not, so don't tell users to click an icon. When buttons are images (like a context menu), describe what the button looks like in parentheses.
Open the context menu (button with three dots). | YES |
Click the three dot icon to open the context menu. | NO |
Lists versus prose
Reserve bulleted and numbered lists for genuinely list-like content: settings, status definitions, comparisons, parallel options. Use prose for explanation; lists shouldn't replace paragraphs that flow naturally.
If the content reads as a sentence with a series ("the integration supports SAML, OIDC, and SCIM"), keep it as prose. If it reads as discrete items the reader will scan for one at a time, use a list.
For reference material in a Go deeper section, tables are often clearer than bullets — particularly for comparisons, parameter definitions, or status enumerations.
Images
Be as sparing as possible with images since they are difficult to maintain long-term. Use screenshots only when they are needed to clarify the instructions given.
When possible, place images above the text that references it.
This helps convey a logical flow from step to step where an image shows the result of an action taken. For example, if you direct readers to click a button to open a new page, an image of that page should appear after the "click button" step and before the instructions of what to do on that page.
Open the profile menu and select Add Event.
The New Event page opens.
[IMAGE OF NEW EVENT PAGE HERE]Enter a Title for the event.
| YES
---|---
Open the profile menu and select Add Event.
The New Event page opens.Enter a Title for the event.
[IMAGE OF THE NEW EVENT PAGE HERE]
| NO
Screenshot specs
Apply a drop shadow to all screenshots so they stand out from the surrounding text. Recommended settings: opacity 25%, offset 0pt, blur 20pt. [NEEDS VERIFICATION: confirm these settings are still current convention before publishing — copied from the prior Help Center Best Practices article and may be stale.]
Think carefully about what to include in the screenshot frame. Show too much and the image dates faster as the UI changes; show too little and the context becomes unclear. Crop to what the reader actually needs to see.
For multi-step workflows where the result of each step matters, an animated GIF can be more effective than a sequence of stills.
Step-by-step instructions and lists
List procedure steps as numbers, not bullet points. If you need to note the result of a step, put it after a line break within the step rather than delineating it as another step. Steps are actions the user takes, not the result of the action.
YES | NO |
Open the profile menu and select Dashboard.
The Dashboard opens.Select Surveys on the left side of the page.
|
Open the profile menu and select Dashboard.
The Dashboard opens.
Select Surveys on the left side of the page.
|
Open the profile menu.
Select Dashboard.
The Dashboard opens.
Combine two steps when the second logically completes the first and it reasonably reduces the number of steps in the process.
3. Open the menu and select Add Event. | YES |
3. Open the menu. 4. Select Add Event. | NO |
Always include the concluding step of a process, such as: Save your changes.
2. Select Edit for the event.3. Edit the Title for the event.4. Save the event.
[END OF PROCESS] | YES |
2. Select Edit for the event.3. Edit the Title for the event. |
|
[END OF PROCESS] | NO |
Bulleted lists should be parallel.
Field Name 1 : it does this
Field Name 2 : it does that
| YES
---|---
Field Name 1 : it does this
Field Name 2 : click this field to do that
| NO
Audit and rewrite process
How to approach an article rewrite
Five steps to follow before drafting a replacement for an existing article:
Audit the current article. What's there, what's accurate, what's missing, what overlaps with other articles in the family. Surface whether deprecation/redirect is the right call rather than rewriting.
Check for cross-cutting content. If multiple articles document the same concept (for example, JMESPath attribute mapping, OAuth setup), propose extracting it into one canonical place rather than rewriting each one separately.
Surface decisions before drafting. If the rewrite needs a call on title, scope, format, or content priorities, ask before drafting rather than after. Title decisions in particular are easier to make once than to reverse after content is written.
Flag downstream effects. What other articles need to update once this one ships: cross-references, deduped content, terminology changes, inbound links from product surfaces or sales collateral.
Validate against source where accessible. See Source validation against code below.
Settings paths and verification flags
Always verify the exact settings path before stating it. Old articles have been wrong about the path multiple times, often using Settings > where the actual path is System Settings >.
Common things to verify before publishing:
Settings paths (for example,
System Settings > Integrations > Slack)Field labels and dropdown options
Default values
Behavior in edge cases (for example, what happens when a setting is left blank, or how a feature behaves on first connect versus reconnect)
When something can't be confirmed from the article being audited, project knowledge, or other source material, mark it inline with [NEEDS VERIFICATION] rather than guessing. Better to ship with an explicit flag than to encode incorrect behavior. Resolve all [NEEDS VERIFICATION] flags before publishing.
Source validation against code
For procedural and reference articles, validate the article's claims against source code when accessible. Claude Code against the PlusPlus repo is the path.
Treat source validation as:
Near-mandatory for reference articles with parameter tables (SAML configuration, integration scopes, attribute mappings). These articles have to be exactly right; one wrong column value can break customer integrations.
High-value for cookbooks with OAuth or other multi-step authentication flows. The original Integration for Slack article documented a restricted-workspace OAuth flow as the universal install path; source validation caught the error on the first rewrite, after that error had been live for years.
Nice-to-have for orientation and 101 articles, where the content is conceptual rather than mechanical.
Run source validation after the draft is otherwise ship-ready, then iterate on findings.
Article deprecation
Deprecation is one of three valid outcomes of an article audit (the others being rewrite-in-place and new-article). Choose deprecation when:
The article's unique content has migrated to a better-organized article in the same family.
The article is built around marketing copy or generic primer content that doesn't belong in the help center.
The article duplicates content already documented elsewhere with better structure.
When recommending an article for deprecation, the audit produces three things:
Redirect target — the article that absorbs the deprecated URL. Pick the closest match in the family.
Content to absorb — any unique information that should move into the redirect target before deprecation. Often none, especially for articles flagged as primarily duplicative.
Inbound-link audit — confirmation that no other help center articles or product surfaces link to the deprecated URL. Search project knowledge for both the article ID and the slug.
In Intercom, deprecate by setting the article to unpublished and configuring a redirect from the old slug to the redirect target.
