technical-writing
Documentation strategy, API references, and release communication workflows
View on GitHubTable of content
Documentation strategy, API references, and release communication workflows
Installation
npx claude-plugins install @gtmagents/gtm-agents/technical-writing
Contents
Folders: agents, commands, skills
Included Skills
This plugin includes 4 skill definitions:
api-style-guide
Style and formatting rules for API/SDK documentation, samples, and tutorials.
View skill definition
API Style Guide Skill
When to Use
- Authoring or updating API references, tutorials, and SDK docs.
- Reviewing contributions from engineers, DevRel, or partners.
- Auditing docs for consistency before releases.
Framework
- Language & Tone – audience-specific tone, terminology list, and banned phrases.
- Structure – endpoint/order conventions, table layouts, code block formatting, error doc patterns.
- Code Samples – naming standards, authentication handling, pagination patterns, inline comments.
- Metadata & Tags – version labels, availability notes, beta flags, locale indicators.
- Accessibility & Localization – heading hierarchy, alt-text, snippet annotations, translation guidance.
Templates
- Reference entry template (description, parameters, responses, examples, notes).
- Tutorial skeleton with prerequisites, steps, troubleshooting, next steps.
- Code sample checklist ensuring env vars, comments, and error handling are included.
Tips
- Keep examples runnable; provide curl equivalents even when primary sample is in another language.
- Link to glossary for shared terminology across teams.
- Pair with
update-api-referencecommand to enforce consistent output.
doc-requirements-matrix
Framework for capturing documentation requirements, scoring priority,
View skill definition
Doc Requirements Matrix Skill
When to Use
- Intake from product, engineering, support, or compliance teams.
- Prioritizing doc requests against limited capacity.
- Tracking readiness requirements for launches or audits.
Framework
- Request Intake – requester, audience, format, deadline, status, linked release.
- Scoring Criteria – impact, urgency, compliance, audience reach, reuse potential.
- Dependencies – SMEs, assets, tooling, localization, approvals.
- Status Tracking – backlog → in progress → review → published → refresh queued.
- Reporting – dashboards for open requests, SLA breaches, and effort allocation.
Templates
- Requirement intake form (Notion/Sheet) with scoring formula.
- Priority board with filters for audience, format, product area.
- Weekly review agenda highlighting top priorities + blockers.
Tips
- Align scoring weights with leadership priorities each quarter.
- Attach spec links, mockups, and SME contacts to reduce back-and-forth.
- Pair with
plan-documentation-roadmapto auto-populate backlog sections.
quality-review-checklist
Checklist covering accuracy, style, accessibility, and localization requirements
View skill definition
Quality Review Checklist Skill
When to Use
- Pre-publication QA for docs, tutorials, and release notes.
- Auditing inherited content during migrations.
- Training new contributors on required review steps.
Framework
- Accuracy & Coverage – verify features, parameters, screenshots, and examples match latest build.
- Style & Voice – enforce style guide, terminology, formatting, and tone per audience.
- Accessibility – heading hierarchy, alt-text, captions, contrast, keyboard navigation, screen-reader cues.
- Localization & Compliance – translation scope, legal disclaimers, export controls, privacy statements.
- Version Control – version tags, changelog entries, rollback plan, owner assignments.
Templates
- QA checklist spreadsheet with pass/fail + notes fields.
- Reviewer sign-off sheet with timestamps and comments.
- Issue log for follow-up fixes grouped by severity.
Tips
- Pair reviewers (technical + editorial) for faster turnarounds.
- Automate linting scripts (links, markdown, accessibility) and attach results to the checklist.
- Use with
publish-release-documentationfor final approvals.
versioning-dashboard
Dashboard pattern for tracking doc coverage across product versions,
View skill definition
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
- Version Inventory – list active versions, release dates, support windows, and owners.
- Artifact Coverage – matrix of docs/tutorials/guides per version + locale + channel.
- Change Log Hooks – tie version changes to release notes, migration guides, and alert cadence.
- Risk & Action Log – highlight outdated assets, missing locales, or compliance needs.
- 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, andupdate-api-referenceworkflows.