RallyPoynt OS Metadata Update Template

This template provides a standardized format for updating document metadata to ensure all RallyPoynt OS content aligns with the new metadata standards. Use this template when implementing metadata changes identified during the document review process.

Metadata Fields Checklist

When updating document metadata, ensure all required fields are properly completed according to the standards below:

Required Metadata Fields

Field	Description	Examples	Required?
title	Descriptive, specific title that clearly indicates content topic	"Client Journey Workflow", "Sales Process Framework"	Required
description	1-2 sentence summary of the document's purpose and content	"Comprehensive workflow mapping the complete client journey from initial contact through transaction completion and ongoing relationship management"	Required
sidebar_position	Numeric position in the sidebar navigation	1, 2, 3, etc.	Required
tags	Keywords relevant to the content for search and filtering	operations, process, workflow, client experience	Required (min 3)
businessAreas	Primary business area(s) the content belongs to	operations, sales, training, systems	Required
relatedContent	Links to related documents in the platform	/docs/business-areas/operations/client-operations	Required (min 2)
contentLevel	Classification of content type	guide, reference, overview, template, tutorial	Required
lastUpdated	Date of last content update	2023-08-19	Required

Optional Metadata Fields

Field	Description	Examples	Required?
sidebar_label	Shorter title used in navigation (if different from title)	"Overview", "Quick Start"	Optional
authors	Content authors or contributors	["J. Smith", "A. Johnson"]	Optional
implementationLevel	Specific implementation levels content applies to	agent, team, brokerage, enterprise	Optional
complexity	Indicates content complexity level	beginner, intermediate, advanced	Optional
prerequisites	Required knowledge or setup before using content	["Basic CRM knowledge", "Active RallyPoynt account"]	Optional
timeToComplete	Estimated time to complete described process	"30 minutes", "1-2 hours", "2 days"	Optional

Metadata Format Example

---
title: End-to-End Client Journey Workflow
description: Comprehensive workflow mapping the complete client journey from initial contact through transaction completion and ongoing relationship management
sidebar_position: 2
tags:
  - operations
  - client journey
  - workflow
  - client experience
  - process
businessAreas:
  - operations
relatedContent:
  - /docs/business-areas/operations/client-operations
  - /docs/business-areas/sales/frameworks/sales-process-framework
  - /docs/business-areas/systems/process-management
contentLevel: guide
implementationLevel:
  - agent
  - team
  - brokerage
complexity: intermediate
lastUpdated: 2023-08-19
---

# Document content starts here...

Business Areas Reference

When selecting business areas, use only the approved values listed below:

Business Area	Description	Applicable Content
operations	Operational processes and procedures	Client management, team operations, transaction management
sales	Sales methodologies and techniques	Lead generation, conversion, sales scripts, negotiations
training	Education and professional development	Skill development, certification, learning paths
systems	Technical systems and process design	Automation, integrations, data management, platforms
documentation	Documentation standards and guides	Style guides, templates, contributor resources

Content Levels Reference

When selecting content level, use only the approved values listed below:

Content Level	Description	Example Uses
overview	High-level introduction to a topic	Business area landing pages, concept introductions
guide	Comprehensive instruction on a topic	Process workflows, implementation guides
reference	Detailed technical information	API documentation, configuration references
tutorial	Step-by-step instructions	Getting started guides, how-to articles
template	Reusable content pattern	Document templates, process frameworks
checklist	Action-oriented verification list	Review checklists, implementation verification

Implementation Process

Follow these steps to update document metadata:

1. Document Assessment

1. Review the document's current metadata
2. Identify missing or incorrect metadata fields
3. Determine the appropriate values for each field based on document content
4. Check if file location aligns with business area

2. Metadata Update

1. Add or update required metadata fields
2. Add relevant optional metadata fields
3. Ensure all field values follow the approved formats
4. Verify tag consistency with similar documents

3. Related Content Linkage

1. Identify at least 2-3 closely related documents
2. Add their paths to the relatedContent field
3. Consider adding this document to their relatedContent fields (reciprocal linking)

4. Verification

1. Validate YAML format is correct (no syntax errors)
2. Confirm all required fields are present
3. Verify business area and content level are from approved lists
4. Check that sidebar position creates logical ordering

Common Metadata Issues and Solutions

Issue	Solution
Generic title	Make title specific to content and include key terms
Missing business area	Add appropriate business area from approved list
Too few tags	Add at least 3 relevant tags that aid in search
Outdated lastUpdated	Update to current date when making content changes
Missing related content	Add at least 2 related documents within the platform
Incorrect content level	Review content purpose and select appropriate level
Inconsistent formatting	Follow exact format shown in example (spacing, indentation)

Metadata Update Examples

Before Update

---
title: Client Journey
description: About the client journey
tags:
  - client
---

# Client Journey

Content here...

After Update

---
title: End-to-End Client Journey Workflow
description: Comprehensive workflow mapping the complete client journey from initial contact through transaction completion and ongoing relationship management
sidebar_position: 2
tags:
  - operations
  - client journey
  - workflow
  - client experience
  - process
businessAreas:
  - operations
relatedContent:
  - /docs/business-areas/operations/client-operations
  - /docs/business-areas/sales/frameworks/sales-process-framework
contentLevel: guide
lastUpdated: 2023-08-19
---

# End-to-End Client Journey Workflow

Content here...

Next Steps After Metadata Update

After updating document metadata:

1. Verify the document appears correctly in navigation
2. Check that the document appears in search results for relevant terms
3. Verify related content links are working properly
4. Update the document review tracking to mark metadata as updated
5. Consider if the document needs content updates based on review findings

---

This template is part of the RallyPoynt OS Documentation Standards. For more information, see the Document Review Framework.