Skip to main content

Documentation Templates

Ready-to-use templates for creating consistent, high-quality documentation across the Pacing Agency tech stack.

Available Templates​

1. Tool Documentation Template​

Use for: Documenting SaaS tools, platforms, and services in the tech stack.

Location: tool-template.md

Includes:

  • Frontmatter with cost tracking and metadata
  • Access and authentication details
  • Integration documentation
  • n8n workflow tracking
  • Scripts and automation section
  • Troubleshooting guide

View Tool Template

2. Feature Documentation Template​

Use for: Documenting reusable Docusaurus features, components, and plugins.

Location: feature-template.md

Includes:

  • Installation and setup instructions
  • API reference with props and types
  • Usage examples (basic and advanced)
  • Styling and customization options
  • Best practices and troubleshooting
  • Setup guide for new repos

View Feature Template

3. Guide Template​

Use for: Creating step-by-step tutorials and educational content.

Location: guide-template.md

Includes:

  • Learning objectives and prerequisites
  • Step-by-step instructions with examples
  • Configuration and code examples
  • Troubleshooting section
  • Real-world case studies
  • Related resources and next steps

View Guide Template

4. Custom Page Template​

Use for: General documentation pages that don't fit other categories.

Location: custom-page-template.md

Includes:

  • SEO metadata (description, keywords)
  • Visual elements (callouts, diagrams, tables)
  • Code examples with syntax highlighting
  • Best practices section
  • Summary and key takeaways

View Custom Page Template

Using Templates​

Use the interactive CLI tool to generate documentation from templates:

cd docusaurus
npm run create-doc

The CLI will:

  1. Ask you which template to use
  2. Prompt for required information
  3. Generate the file in the correct location
  4. Pre-fill frontmatter and metadata

Method 2: Manual Copy​

Copy the template file and customize it manually:

# For tool documentation (source of truth)
cp docusaurus/docs/docusaurus/templates/tool-template.md tools/my-new-tool.md

# For feature documentation
cp docusaurus/docs/docusaurus/templates/feature-template.md docusaurus/docs/docusaurus/features/my-feature.md

# For guides
cp docusaurus/docs/docusaurus/templates/guide-template.md docusaurus/docs/Guides/my-guide.md

# For custom pages
cp docusaurus/docs/docusaurus/templates/custom-page-template.md docusaurus/docs/my-page.md

Then edit the file and replace all placeholders (in [brackets]).

Template Placeholders​

All templates use placeholders that you should replace:

PlaceholderDescriptionExample
[Tool Name]Name of the toolGoogle Analytics
[category]Tool category constantMARKETING_TOOL
[YYYY-MM-DD]Date in ISO format2026-01-06
[number]Sidebar position1, 2, 3
[slug]URL-friendly identifiergoogle-analytics

Template Categories​

Tool Categories​

When documenting tools, use these category constants in frontmatter:

  • WEBSITE - Website hosting and CMS
  • SELF_HOSTING - Self-hosted services and infrastructure
  • OPERATIONAL_TOOLS - Business operations and productivity
  • SOCIAL_MEDIA - Social media platforms and management
  • MARKETING_TOOL - Marketing automation and analytics
  • DESIGN_CONTENT - Design tools and content creation
  • AD_SPEND - Advertising platforms
  • OFFICE_COWORKING - Office and coworking spaces
  • CRM - Customer relationship management

Account Types​

Use these account type constants:

  • CLIENT_OWNED - Client owns the account
  • INTERNAL - Agency-owned account
  • CLIENT_ACCESS - Client has access to agency account

Frontmatter Guidelines​

Required Fields​

All documentation should include:

---
id: unique-identifier
title: Display Title
sidebar_label: Short Label
---

Tool-Specific Fields​

Tool documentation requires:

---
title: Tool Name
category: CATEGORY_CONSTANT
monthlyCost: 0
annualCost: 0
accountType:
  - TYPE_CONSTANT
---

Optional Fields​

Enhance SEO and organization with:

---
sidebar_position: 1
description: Brief description for SEO
keywords: [keyword1, keyword2]
---

Best Practices​

Content Guidelines​

  • Be specific: Include actual examples, not generic placeholders
  • Stay concise: Short paragraphs (2-3 sentences maximum)
  • Use British English: realise, optimise, colour, etc.
  • Link internally: Reference related tools, features, and guides
  • Update regularly: Keep documentation current with actual usage

Structure Guidelines​

  • Use H2 for main sections: ## Section Title
  • Use H3 for subsections: ### Subsection Title
  • Include code examples: Show, don't just tell
  • Add visual elements: Use callouts, tables, and diagrams
  • Provide context: Explain why, not just how

Maintenance Guidelines​

  • Update dates: Keep "Last Updated" current
  • Track versions: Document changes in Version History
  • Clean up TODOs: Remove completed items regularly
  • Test links: Verify internal and external links work
  • Review quarterly: Check documentation is still accurate

Template Customization​

Adding Sections​

Feel free to add sections relevant to your use case:

## Custom Section

[Your content here]

Removing Sections​

Remove sections that aren't relevant:

<!-- Remove sections you don't need -->

Reordering Sections​

Reorder sections to match your workflow:

## Most Important Section (moved to top)

## Less Important Section (moved down)

Examples​

Example 1: Tool Documentation​

Browse the Tools section to see complete examples of tool documentation following the template.

Example 2: Feature Documentation​

See callout-component.md for a complete example of feature documentation.

Example 3: Guide Documentation​

See Guides section for examples of step-by-step guides.

CLI Tool Reference​

The interactive CLI tool (npm run create-doc) supports:

Tool Creation​

  • Prompts for tool name, category, costs
  • Auto-generates frontmatter
  • Places file in tools/ directory
  • Auto-syncs to Docusaurus on next build

Feature Creation​

  • Prompts for feature name and details
  • Places file in docusaurus/docs/docusaurus/features/
  • Generates component file structure

Guide Creation​

  • Prompts for guide title and category
  • Places file in appropriate guide section
  • Generates guide structure

Custom Page Creation​

  • Prompts for page title and location
  • Generates custom page structure
  • Adds to sidebar if requested

Contributing​

To improve these templates:

  1. Edit template files in docusaurus/docs/docusaurus/templates/
  2. Update this index page with changes
  3. Test templates by creating new documentation
  4. Submit improvements via pull request

Last Updated: 2026-01-06
Maintained By: Pacing Agency Tech Team
Status: Active