Knowledge Base: Titles and Naming Conventions

Summary

How to name articles and headings in the Knowledge Base.

Body

  • Keep client-facing titles concise and action oriented
  • There are basically two kinds of client-facing articles: Single Topic Articles, and Guide Articles
    • For single-topic articles, when possible, start with the application name
      • "Chemdraw: Installation & Set-up"
    • For Guide articles (articles that gather together several topic articles, internal and external, into a single guide, like all the steps in setting up a new computer" add "Quick Start Guide" after the semi-colon
      • e.g. "Setting up your new computer: Quick Start Guide"
  • For restricted content (hidden from the public) add a phrase that indicates audience:
    • " - Carleton Only" for things where Carleton clients need to be logged in
      • e.g. "SPSS Licenses - Carleton Only"
    • " - ITS Only" for things restricted to ITS staff
      • e.g. "Helpdesk Phones - ITS Only"
  • For Headings, keep things action oriented
    • "How to Install" is a common heading to use frequently

Details

Details

Article ID: 145100
Created
Fri 7/15/22 5:37 PM
Modified
Mon 7/18/22 12:59 PM

Related Articles

Related Articles (1)

ITS Knowledge Base Style Guide: Quick Start Guide
Overarching principles for Knowledge Base articles, plus specific decisions about naming conventions, use of images, etc that will help our Knowledge Base look consistent and predictable to our community.