Initial commit
This commit is contained in:
34
commands/plan-documentation-roadmap.md
Normal file
34
commands/plan-documentation-roadmap.md
Normal file
@@ -0,0 +1,34 @@
|
||||
---
|
||||
name: plan-documentation-roadmap
|
||||
description: Produces quarterly documentation roadmap with priorities, staffing, and KPIs.
|
||||
usage: /technical-writing:plan-documentation-roadmap --quarter Q2 --audiences developers,admins --formats docs,video --capacity 2-writers
|
||||
---
|
||||
|
||||
# Command: plan-documentation-roadmap
|
||||
|
||||
## Inputs
|
||||
- **quarter** – planning period (e.g., Q1, Q2, H1, FY).
|
||||
- **audiences** – comma-separated list (developers, admins, operators, sales, cs, internal).
|
||||
- **formats** – docs, tutorials, video, release-notes, api-reference (comma-separated).
|
||||
- **capacity** – optional headcount or bandwidth context.
|
||||
- **tooling** – optional doc platform references.
|
||||
|
||||
## Workflow
|
||||
1. **Audit & Signals** – pull analytics, support tickets, NPS themes, and stakeholder requests.
|
||||
2. **Prioritization** – score opportunities by impact, urgency, and resource fit.
|
||||
3. **Roadmap Draft** – map initiatives, milestones, dependencies, and staffing needs.
|
||||
4. **Governance Layer** – define review cadences, localization, compliance steps.
|
||||
5. **Executive Pack** – summarize KPIs, investments, and risks for approval.
|
||||
|
||||
## Outputs
|
||||
- Roadmap doc/deck with initiatives, timelines, and owners.
|
||||
- Resourcing + tooling plan with capacity notes.
|
||||
- KPI tracker outlining target metrics and reporting cadence.
|
||||
|
||||
## Agent/Skill Invocations
|
||||
- `documentation-architect` – leads audit + roadmap decisions.
|
||||
- `release-documentation-manager` – highlights launch dependencies.
|
||||
- `doc-requirements-matrix` skill – enforces requirement capture + scoring.
|
||||
- `versioning-dashboard` skill – ties roadmap to version support lifecycle.
|
||||
|
||||
---
|
||||
34
commands/publish-release-documentation.md
Normal file
34
commands/publish-release-documentation.md
Normal file
@@ -0,0 +1,34 @@
|
||||
---
|
||||
name: publish-release-documentation
|
||||
description: Coordinates release notes, changelog, and enablement updates for a launch.
|
||||
usage: /technical-writing:publish-release-documentation --release "2026.2" --audiences developers,admins,cs --channels docs,email,in-app --deadline 2025-12-15
|
||||
---
|
||||
|
||||
# Command: publish-release-documentation
|
||||
|
||||
## Inputs
|
||||
- **release** – version identifier or codename.
|
||||
- **audiences** – comma-separated (developers, admins, cs, marketing, exec, partners).
|
||||
- **channels** – docs, email, in-app, community, enablement.
|
||||
- **deadline** – target publication date.
|
||||
- **locales** – optional localization requirements (en, es, jp, etc.).
|
||||
|
||||
## Workflow
|
||||
1. **Feature Intake** – capture feature list, risk notes, screenshots, approvals needed.
|
||||
2. **Artifact Plan** – map which assets are needed per audience/channel.
|
||||
3. **Workback Schedule** – assign owners, deadlines, and review checkpoints.
|
||||
4. **Quality Review** – enforce style, accuracy, accessibility, and localization steps.
|
||||
5. **Publishing & Notification** – push updates to doc portals, status pages, comms channels; log changelog entry.
|
||||
|
||||
## Outputs
|
||||
- Release communication packet (notes, changelog, enablement summary).
|
||||
- Workback tracker with task status and owners.
|
||||
- QA + localization checklist with sign-offs.
|
||||
|
||||
## Agent/Skill Invocations
|
||||
- `release-documentation-manager` – orchestrates workflow + approvals.
|
||||
- `documentation-architect` – ensures governance compliance.
|
||||
- `quality-review-checklist` skill – enforces QA + accessibility steps.
|
||||
- `versioning-dashboard` skill – updates version support + retirement info.
|
||||
|
||||
---
|
||||
34
commands/update-api-reference.md
Normal file
34
commands/update-api-reference.md
Normal file
@@ -0,0 +1,34 @@
|
||||
---
|
||||
name: update-api-reference
|
||||
description: Generates API reference + guides updates from new schema changes with samples and changelog entries.
|
||||
usage: /technical-writing:update-api-reference --spec openapi.yaml --audience developers --outputs reference,guide --languages js,python
|
||||
---
|
||||
|
||||
# Command: update-api-reference
|
||||
|
||||
## Inputs
|
||||
- **spec** – OpenAPI/AsyncAPI file path or URL.
|
||||
- **audience** – developers | partners | internal | admins.
|
||||
- **outputs** – reference, guide, changelog, tutorial (comma-separated).
|
||||
- **languages** – code sample languages (js, python, curl, java, go, ruby, csharp).
|
||||
- **breaking-change** – true/false toggle for migration guidance.
|
||||
|
||||
## Workflow
|
||||
1. **Spec Diff & Analysis** – compare schema version vs prior baseline, note new/changed/deprecated endpoints.
|
||||
2. **Content Scope** – determine docs to update (reference tables, tutorials, SDK snippets, changelog entries).
|
||||
3. **Drafting** – produce updated endpoint descriptions, parameters, responses, usage notes, and code samples per language.
|
||||
4. **Review Loop** – route drafts to engineering/product for validation and to editorial for style compliance.
|
||||
5. **Publishing & Versioning** – push updates, tag version support, update changelog + migration guidance.
|
||||
|
||||
## Outputs
|
||||
- Updated API reference markdown/HTML with highlighted changes.
|
||||
- Code sample bundle per requested languages.
|
||||
- Changelog excerpt + migration guidance (if applicable).
|
||||
|
||||
## Agent/Skill Invocations
|
||||
- `api-docs-editor` – leads spec diff + doc updates.
|
||||
- `documentation-architect` – ensures IA + governance alignment.
|
||||
- `api-style-guide` skill – enforces terminology, formatting, and code sample rules.
|
||||
- `versioning-dashboard` skill – logs version info + deprecation timelines.
|
||||
|
||||
---
|
||||
Reference in New Issue
Block a user