This page defines the authoring standards for the centrexIT Knowledge Center. Use it as a quick reference when creating or reviewing articles.
Title Standards
Section titled “Title Standards”- Use title case for all article titles.
- Prefix titles with the KB number (e.g.,
KB00012345 — Configuring SSO for Microsoft 365). - Titles should be descriptive and specific. A reader should understand the article’s scope from the title alone.
- Avoid jargon and abbreviations unless they are widely understood by the target audience.
Tone and Voice
Section titled “Tone and Voice”- Write in a professional, direct tone.
- Use second person (“you”) when giving instructions.
- Avoid unnecessary jargon — explain technical terms when first introduced.
- Be concise. Every sentence should add value; remove filler.
- Use active voice (“Click the button” not “The button should be clicked”).
- Keep paragraphs short and scannable.
Document Type System
Section titled “Document Type System”Every article must declare one of the seven canonical document types via the docType frontmatter field. Choose the type that best matches the article’s purpose.
| Doc Type | Purpose |
|---|---|
| Policy | Rules, expectations, and governance. Answers “what” and “why.” |
| Standard | Required configurations, baselines, and technical specifications. Defines measurable criteria. |
| Process | High-level workflows describing phases, KPIs, inputs, and outputs. |
| Procedure | Step-by-step operational instructions for tasks like escalation, patching, or provisioning. |
| Work Instruction | Detailed, tool-specific guides for completing a task in a specific system or application. |
| Reference | Lookup tables, configuration values, architecture notes, and other factual resources. |
| Manual | Comprehensive, multi-chapter guides such as onboarding handbooks or admin guides. |
Quality Criteria
Section titled “Quality Criteria”- Accurate — Information must be verified and technically correct.
- Current — Content should reflect the latest product versions and processes.
- Complete — Cover the topic end-to-end. Do not leave gaps the reader must fill on their own.
- Structured — Use clear headings, numbered steps, and bullet lists to organize content.
- Actionable — Tell the reader what to do, not just what exists.
- Include prerequisites at the top of procedural articles.
- Link to related articles so readers can explore connected topics.
Metadata Requirements
Section titled “Metadata Requirements”Every article includes YAML frontmatter at the top of the file. The following fields are available:
| Field | Required | Description |
|---|---|---|
title | Yes | The display title of the article. |
docType | Yes | One of the seven canonical document types listed above. |
description | No | A short summary shown in search results and link previews. |
company | No | The company or product the article relates to (e.g., Halo, Microsoft). |
subcategory | No | A finer grouping within the article’s category for filtered views. |
lastUpdated | No | Set to false to hide the last-updated date, or omit to show it automatically. |
Taxonomy and Categories
Section titled “Taxonomy and Categories”Articles are organized into category directories under src/content/docs/. The category is derived automatically from the directory name (the first segment of the file path).
Available categories:
work-instructions/procedures/standards/processes/policies/reference/manuals/guides/
Place each article in the directory that matches its document type. The taxonomy labels displayed in the UI are centralized in src/data/taxonomy.ts — do not duplicate or override them.
Cross-Referencing
Section titled “Cross-Referencing”- Link to related articles using relative markdown links (e.g.,
[Reset MFA](../procedures/reset-mfa/)). - Use KB numbers when referencing articles in prose for precise identification.
- Backlinks are generated automatically by the knowledge graph — you do not need to manage them manually.
- Prefer linking to the most specific article rather than a general overview.
Review and Governance
Section titled “Review and Governance”- Articles should be reviewed periodically to ensure accuracy and relevance.
- Outdated content should be flagged for update or archived promptly.
- Each article should have a clear owner responsible for its maintenance.
- When updating an article, verify that linked articles and prerequisites are still valid.