Internal Content Management Strategy

This is a good place to start with defining your internal knowledge strategy. Also consider including an overview of your category structure.

IN THIS GUIDE

Before writing a new Tettra page

Why are you writing the article? Defining the question before drafting the resolution helps identify puzzle pieces, and where they need to go when you start writing.

What is the purpose of the article? Think about what you want the reader to accomplish.

What does the article look like? Pay attention to formatting, paragraph structure, image placement, and overall length of the article.

Complex topics can require long explanations, but sometimes more specific content is more helpful. Break out long articles that cover multiple, related topics, into separate articles when appropriate.

Formatting Pages

Headings and sub-headings (H1, H2, and H3)

Additional headings help break up ideas and important concepts. Headings can sub-headings can be a little longer and more specific than page titles.

Use Header 1 for primary section titles. Use Header 2 for sub-headings under Header 1.

Heading 1

Heading 2

HEADING 3

Step-based instructions

In step-by-step instructions, capitalize and bold app button labels as they appear in the app. Capitalize and italicize navigation.

Click Submit Report when you are ready to submit

Lists and bulleted lists

Ordered (numbered) lists can be used to explain a series of steps or reminders that don’t require multiple actions or related images. Unordered (bulleted) lists are helpful for grouping together concepts or ideas.

When a list item is a complete sentence use a period at the end of the bulleted item.
Phrases don't get a period

Bold Text

Bold text is reserved for highlighting specific call-to-action items. When writing step-based instructions, use bold text to highlight the name of a menu item, link, or button: “Click the Notifications link. Select your desired notifications, then click Save Notifications.”

Linking Pages

Linking Tettra pages in pages. Use '+' to search for published pages and link the full page. To link to a sub-section of a page:

Click on the page in the left-hand menu
Right-click on the header you want to link > copy link address
In your DRAFT page highlight copy and COMMAND + K to link

Using Templates

Always check for a template for the kind of document you're creating - using templates assures that your document contains all the necessary information in a format that's standardized and easy to read.

Before clicking the "Share" button, consider who needs to see this document and choose the appropriate channel for sharing (so you don't create noise for anyone).

Also consider whether they'll need to know what you changed, if this is an update - you can direct them to the most recent Version History, or give them a quick summary in the notes when you share to Slack.

Don't forget to give the article another quick once-over before you publish, to look for errors or formatting inconsistencies.