playbooks

home / skills / gtmagents / gtm-agents / versioning-dashboard

versioning-dashboard skill

/plugins/technical-writing/skills/versioning-dashboard

This skill helps you manage versioning dashboards by tracking product versions, locales, and channels, with actionable insights for leadership.

npx playbooks add skill gtmagents/gtm-agents --skill versioning-dashboard

Review the files below or copy the command above to add this skill to your agents.

Files (1)
SKILL.md
1.4 KB
---
name: versioning-dashboard
description: Dashboard pattern for tracking doc coverage across product versions,
  locales, and channels.
---

# Versioning Dashboard Skill

## When to Use
- Managing multiple product versions, editions, or deployment models.
- Coordinating deprecations, migrations, and long-term support documentation.
- Reporting readiness and gaps to leadership during launches.

## Framework
1. **Version Inventory** – list active versions, release dates, support windows, and owners.
2. **Artifact Coverage** – matrix of docs/tutorials/guides per version + locale + channel.
3. **Change Log Hooks** – tie version changes to release notes, migration guides, and alert cadence.
4. **Risk & Action Log** – highlight outdated assets, missing locales, or compliance needs.
5. **Reporting Layer** – KPIs (coverage %, SLA adherence, reader metrics) with filters for audience or product area.

## Templates
- Dashboard sheet with pivoted coverage views and status chips.
- Migration tracker linking deprecated features to comms + doc updates.
- Executive summary slide with version highlights and asks.

## Tips
- Integrate with source control metadata to auto-update coverage status.
- Highlight dependencies (SDKs, integrations) when versions shift.
- Pair with `plan-documentation-roadmap`, `publish-release-documentation`, and `update-api-reference` workflows.

---

Overview

This skill provides a production-ready dashboard pattern to track documentation coverage across product versions, locales, and channels. It helps teams inventory active releases, surface gaps, and communicate readiness for launches and deprecations. Designed for cross-functional GTM teams, it produces actionable reporting and escalation paths to close doc debt.

How this skill works

The dashboard ingests a version inventory and maps documentation artifacts (guides, tutorials, API references) across versions, locales, and channels to produce a pivotable coverage matrix. It links change events and release notes to specific assets, flags risks and missing locales, and maintains an action log for owners. A reporting layer exposes KPIs like coverage percentage, SLA adherence, and reader metrics with filters for product area and audience.

When to use it

  • Managing multiple product versions, editions, or deployment models
  • Coordinating deprecations, migrations, and long-term support documentation
  • Reporting readiness and coverage gaps to leadership before launches
  • Tracking localization progress and channel-specific assets
  • Aligning engineering, docs, and GTM teams around versioned deliverables

Best practices

  • Maintain a single version inventory with owners, release dates, and support windows to avoid stale data
  • Integrate with source control and CI metadata to auto-update coverage and reduce manual effort
  • Use a matrix view showing artifact × version × locale to quickly identify gaps
  • Link change log hooks to migration guides and release notes for traceability
  • Keep a risk & action log with clear owners and SLAs for remediation

Example use cases

  • Launch readiness: confirm docs, tutorials, and FAQs are available for the new version and target locales
  • Deprecation planning: map deprecated features to migration guides, comms, and removal timelines
  • Localization tracking: report progress per locale and prioritize high-impact pages for translation
  • Executive reporting: generate an executive summary slide with coverage KPIs and top asks
  • Migration programs: coordinate cross-team tasks when a major protocol or SDK changes

FAQ

Can the dashboard auto-update from source control?

Yes. Integrate repository metadata and CI outputs to surface coverage changes and reduce manual updates.

Which KPIs should we prioritize?

Start with coverage percentage, SLA remediation time for missing assets, and reader engagement on migrated content; expand as needs evolve.