Initial commit

This commit is contained in:
Zhongwei Li
2025-11-29 18:32:04 +08:00
commit e475d70950
13 changed files with 417 additions and 0 deletions

View File

@@ -0,0 +1,30 @@
---
name: api-style-guide
description: Style and formatting rules for API/SDK documentation, samples, and tutorials.
---
# 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
1. **Language & Tone** audience-specific tone, terminology list, and banned phrases.
2. **Structure** endpoint/order conventions, table layouts, code block formatting, error doc patterns.
3. **Code Samples** naming standards, authentication handling, pagination patterns, inline comments.
4. **Metadata & Tags** version labels, availability notes, beta flags, locale indicators.
5. **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-reference` command to enforce consistent output.
---

View File

@@ -0,0 +1,31 @@
---
name: doc-requirements-matrix
description: Framework for capturing documentation requirements, scoring priority,
and assigning owners.
---
# 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
1. **Request Intake** requester, audience, format, deadline, status, linked release.
2. **Scoring Criteria** impact, urgency, compliance, audience reach, reuse potential.
3. **Dependencies** SMEs, assets, tooling, localization, approvals.
4. **Status Tracking** backlog → in progress → review → published → refresh queued.
5. **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-roadmap` to auto-populate backlog sections.
---

View File

@@ -0,0 +1,31 @@
---
name: quality-review-checklist
description: Checklist covering accuracy, style, accessibility, and localization requirements
for documentation releases.
---
# 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
1. **Accuracy & Coverage** verify features, parameters, screenshots, and examples match latest build.
2. **Style & Voice** enforce style guide, terminology, formatting, and tone per audience.
3. **Accessibility** heading hierarchy, alt-text, captions, contrast, keyboard navigation, screen-reader cues.
4. **Localization & Compliance** translation scope, legal disclaimers, export controls, privacy statements.
5. **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-documentation` for final approvals.
---

View File

@@ -0,0 +1,31 @@
---
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.
---