¶ Wiki Page Types, Tags, Images & Folder Structure Guidelines
¶ Page Types
There are 2 types of Wiki pages: “How-To” and “Reference”
¶ Folder Structure
Adhere to the existing folder structure:
- IntersectCompanyInfo (things about how our company works not development specific)
- Wiki
- IntersectProjectManagement
- IntersectDeveloperResources (If we have a reference page that’s all-client-encompassing put it here)
- ADA
- Kellanova
- Development
- Systems
- (Some system name like DAM)
- SetupTools
- Account
¶ Tagging
Tag each article with exactly one of: “how-to” or “reference”
¶ Image Naming Convention
When adding images to a page, give each image a meaningful clear name. This gives authors an opportunity to more easily find and re-use existing images (where it applies) instead of needing to create new ones.
DON’T:
- use only numbers such as 1.png, 2.png etc
- use unclear acronyms that are not already known business jargon such as yitwwidt.png (why in the world would I do this.png)
- use spaces in file names
Example of unclear, difficult to quantify, naming convention
DO:
- name an image with meaningful context (recipe-ingredient-list.png)
- use meaningful acronyms that are already known (mt-workfront-ticket.png) where mt would be reference to Mind Tree (a known acronym used frequently)
- use lower case names with dashes or underscores for easy readabilty
Example of clear, easy to identify, naming convention
