Help:Naming standards
- This page was last modified on December 5, 2011, at 11:26.
From (mt) Community Wiki
This is an ongoing list of words and phrases, both general and (mt) specific, that wiki users should adhere to. We expect this list to keep growing and GROWing and GROWING...
- (mt) Media Temple
- AccountCenter
- (gs) Grid-Service
- (dv) Dedicated-Virtual Server
- (dv) 2.0 or (dv) 3.0 or (dv) 3.5
- (ve) Server
- (ve) 512MB Server
- (ve) 1GB Server
- (ve) 2GB Server
- (ve) 4GB Server
- (ve) 8GB Server (coming soon)
- (ve) 16GB Server (coming soon)
- MailProtect
- MySQL
- phpMyAdmin
- (dpv) Nitro
- (dpv) Turbo (hardware modified nitro)
- support request
- nameserver
- domain name
- email (try to stay away from mail, e-mail, Email, E-mail)
- GridContainer
Title names
Generic:
NAMESPACE:Action Category Software Error Type on Platform
Sample article titles:
(mt):Add or modify an AccountCenter Contact
(gs):SSH connection
(dv):Reinstall server
(ve):Django with Nginx on Ubuntu
(gs):Migrate to DV
You don't have to include every element shown in the example. And, if a different word order makes more sense, feel free to switch things up. The general rule of thumb is to leave out as many words as you can and still make the title coherent and searchable. i.e., (gs):Set up email account in Apple Mail walkthrough is not as good as (gs):Email settings for Apple Mail.
- The only mandatory part of the article name is the namespace. You can choose from the following:
- (mt) (for AccountCenter generic articles and non-server products like the API)
- (gs)
- (dv)
- (ve)
If your article is relevant to more than one server type, make a copy and update your example paths to be relevant to the appropriate server. If you're really not sure where to put it, add it to the MT namespace.
- Action: add, modify, delete, create, install
- Cateogy: email, FTP, SSL, Apache, user, AccountCenter
- Software: Apple Mail, PuTTY, WordPress, FileZilla, Django
- Error: 403 Forbidden, permission denied, not trusted - Use likely search terms.
- Type: information, troubleshooting - If it's a walkthrough, don't include type. Otherwise, it may be helpful to, for example, differentiate Email troubleshooting from the other email articles.
- on Platform: DV 3.5, Ubuntu, GS Lite - Use this extra designation if an article is for a specific (mt) Media Temple platform and is not relevant to all server types within the namespace category. This is most often needed for (ve) Server articles.
Other title conventions
-
Capitalize only the first word, unless there is a proper name later in the title.
- No: Setting Up Email On Your Blackberry
- Yes: Email settings for Blackberry
- Do not use punctuation. This results in ugly characters in URLs.
-
Do not make the title a question.
- No: How can I edit php.ini on the Grid-Service?
- Yes: (gs):Edit php.ini
- Use two capital letters for branding, rather than the normal (xx) branding. This, again, is for URLs.
- Make two articles if your article applies to both (gs) and (dv). Update examples in each article as appropriate.
-
Avoid "ing" words. Verbs should be in the imperative tense.
- No: Setting up and troubleshooting formmail
- Yes: (gs):Formmail
-
Use the singular where possible.
- No: Adding and modifying Contacts
- Yes: (mt):Add or modify an AccountCenter Contact
- Use "and" or "or" if the title requires it.
-
Do not include "walkthrough," "instructions," or "how to" in the title. It is assumed that an article in the wiki will be some kind of instructions.
- No: How to configure Outlook
- Yes: (dv):Email settings for Outlook