Skip to content

Common Templates

This document describes the standard templates used across all business units for maintaining consistent documentation.

Overview

Our template system provides standardized formats for: - Category documentation - Requirements specification - Validation procedures

Category Template

The category template (category.md.j2) provides a standard structure for documenting standards specific to each business unit or technology category.

Structure

Markdown
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
# [Category] Standards

## Overview
Brief description of the category standards

## Table of Contents
Auto-generated from sections

## Standards
Detailed standards sections

## Related Documents
Links to requirements and validation

## Version History
Version tracking table

Usage

  1. Copy the template from standards/_templates/category.md.j2
  2. Replace placeholders:
  3. {{ category_name }}: Name of the category
  4. {{ sections }}: List of standard sections
  5. {{ current_date }}: Current date for versioning

Requirements Template

The requirements template (requirements.md.j2) standardizes how we document technical requirements and specifications.

Structure

Markdown
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
# [Category] Requirements

## Core Requirements
- Priority levels
- Acceptance criteria

## Technical Specifications
- Implementation guidelines
- Dependencies

## Validation Methods
- Testing procedures
- Compliance checks

## Quality Gates
- Stage-specific requirements

Usage

  1. Copy from standards/_templates/requirements.md.j2
  2. Define:
  3. Core requirements with priorities
  4. Technical specifications
  5. Dependencies and versions
  6. Compliance requirements

Validation Template

The validation template (validation.md.j2) ensures consistent quality assurance across projects.

Structure

Markdown
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
# [Category] Validation

## Validation Checklist
- Testing requirements
- Quality metrics

## Automated Testing
- Unit tests
- Integration tests
- E2E tests

## Code Quality
- Static analysis
- Security scanning
- Performance testing

Usage

  1. Copy from standards/_templates/validation.md.j2
  2. Configure:
  3. Test coverage requirements
  4. Quality thresholds
  5. Validation procedures
  6. Monitoring metrics

Best Practices

  1. Template Customization
  2. Keep core structure intact
  3. Add category-specific sections as needed

  4. Maintain consistent formatting

  5. Version Control

  6. Document all template changes
  7. Update version history

  8. Notify stakeholders of changes

  9. Integration

  10. Link related documents
  11. Reference relevant standards
  12. Maintain documentation hierarchy

Template Maintenance

  1. Regular Reviews
  2. Quarterly template audits
  3. Update based on feedback

  4. Ensure alignment with standards

  5. Change Process

  6. Submit template changes via PR
  7. Include change justification
  8. Update all dependent docs