https://github.com/revenuecat/revenuecat-content-guide
The repository hold the Content Guide use for writing technical content
https://github.com/revenuecat/revenuecat-content-guide
Last synced: 3 months ago
JSON representation
The repository hold the Content Guide use for writing technical content
- Host: GitHub
- URL: https://github.com/revenuecat/revenuecat-content-guide
- Owner: RevenueCat
- Created: 2021-06-22T18:28:01.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2021-07-28T19:10:29.000Z (almost 5 years ago)
- Last Synced: 2025-01-18T05:46:58.693Z (over 1 year ago)
- Size: 416 KB
- Stars: 1
- Watchers: 6
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
#
Welcome to RevenueCat's Content Guide
This guide is predominantly for RevenueCat employees, but anyone can view how we communicate in our content.
# How to Use Our Content Style Guide
Our content style guide was created to create consistency with how we communicate in our documentation and through support. This document will serve as a place for how to utilize our content style guide.
Content Style Guide Table of Contents
- [Goals](https://github.com/RevenueCat/revenuecat-content-guide/blob/main/01-goals.md)
- [Voice and Tone](https://github.com/RevenueCat/revenuecat-content-guide/blob/main/02-voice-and-tone.md)
- [Grammar and Mechanics](https://github.com/RevenueCat/revenuecat-content-guide/blob/main/03-grammar-and-mechanics.md)
[Links](https://github.com/RevenueCat/revenuecat-content-guide/blob/main/03-grammar-and-mechanics.md#links)
[Click vs Select](https://github.com/RevenueCat/revenuecat-content-guide/blob/main/03-grammar-and-mechanics.md#click-vs-select)
[Italics](https://github.com/RevenueCat/revenuecat-content-guide/blob/main/03-grammar-and-mechanics.md#italics)
[Bold](https://github.com/RevenueCat/revenuecat-content-guide/blob/main/03-grammar-and-mechanics.md#bold)
[Capitalization](https://github.com/RevenueCat/revenuecat-content-guide/blob/main/03-grammar-and-mechanics.md#capitalization)
[Code in Text](https://github.com/RevenueCat/revenuecat-content-guide/blob/main/03-grammar-and-mechanics.md#code-in-text)
[Contractions](https://github.com/RevenueCat/revenuecat-content-guide/blob/main/03-grammar-and-mechanics.md#contractions)
[Dates](https://github.com/RevenueCat/revenuecat-content-guide/blob/main/03-grammar-and-mechanics.md#dates)
[Exclamation Points](https://github.com/RevenueCat/revenuecat-content-guide/blob/main/03-grammar-and-mechanics.md#exclamation-points)
[Hyphens](https://github.com/RevenueCat/revenuecat-content-guide/blob/main/03-grammar-and-mechanics.md#hyphens)
[Numbers](https://github.com/RevenueCat/revenuecat-content-guide/blob/main/03-grammar-and-mechanics.md#numbers)
[Emojis](https://github.com/RevenueCat/revenuecat-content-guide/blob/main/03-grammar-and-mechanics.md#emojis)
[Writing About RevenueCat](https://github.com/RevenueCat/revenuecat-content-guide/blob/main/03-grammar-and-mechanics.md#writing-about-revenuecat)
- [Creating Structured Content](https://github.com/RevenueCat/revenuecat-content-guide/blob/main/04-creating-structured-content.md)
## What is a Content Style Guide?
A content style guide is a set of standards for writing and formatting our content. Her[e](http://content.Here) RevenueCat at one of our pillars is being customer-obsessed. One we display this is creating a consistent experience for all individuals coming to RevenueCat. We always want to stick true to our goals in our writing.
## When to Use Our Content Style Guide?
Our content guide can be used for all facets in RevenueCat where we are communicating to our customers. We recommend reviewing the [goals](https://github.com/RevenueCat/revenuecat-content-guide/blob/main/01-goals.md) and [voice and tone](https://github.com/RevenueCat/revenuecat-content-guide/blob/main/02-voice-and-tone.md) guides before writing documentation. When editing documentation or any writing the content guide can be a source of truth formatting and grammar needs. We also have a section on how to create tables, lists, photos, etc to comply with our standards.
## Using our Content Style Guide
We have a quick checklist for editing documentation. Although this does not fully capture all areas of the content guide it highlights some key areas.
### Content Check List
- [ ] Review the RevenueCat [Voice and Tone Guide](https://github.com/RevenueCat/revenuecat-content-guide/blob/main/02-voice-and-tone.md)
- [ ] Titles are capitalized with [title case](https://github.com/RevenueCat/revenuecat-content-guide/blob/main/03-grammar-and-mechanics.md#headerstitles---title-case)
- [ ] Bold words/content are used for referring to UI elements or drawing emphasis
- [ ] 'select' is used in any instances of 'click'
- [ ] Italicized words/content are used only for defining a word/phrase or referring to books, movies, and other full-length works.
- [ ] [Descriptive links](https://github.com/RevenueCat/revenuecat-content-guide/blob/main/03-grammar-and-mechanics.md#links) are used
- [ ] Tables, Lists, and Photos are properly structured based on our [guide](https://github.com/RevenueCat/revenuecat-content-guide/blob/main/04-creating-structured-content.md)
- [ ] Urgent information has been separated into a [callout](https://github.com/RevenueCat/revenuecat-content-guide/blob/main/04-creating-structured-content.md#callouts) ( for ReadMe docs )
## Adding a File
The guide contains markdown files. When adding a new file, name your file without spaces and a `.md` or `.markdown` extension.
The files in this guide are prefixed with a double-digit to set order. Make sure your file starts with a number that will place your new content in the desired position (e.g.: `02`-) and change the prefixes of the other files to reflect this change in order.
## Managing Content
When updating or adding content to our current pages, submit a pull request and add a reviewer. Please provide as much detail as you can when submitting your pull request.