AGENT SKILL

docs-release-maintenance

Manage developer documentation release, publishing, ownership, freshness, automation, maintenance, SaaS cadence, deprecation, deletion, redirects, and migration alongside software changes. Use when planning docs for a release, defining docs ownership, creating publishing checklists, setting up freshness checks, refreshing existing content, documenting SaaS releases, or retiring stale documentation.

License 许可
MIT
最近更新
2026-11-14
Stars
★ 1.6k
Forks
491

01 前言 Front Matter

name
docs-release-maintenance
license
MIT
metadata
{ "tags": "developer-docs,technical-writing,documentation,release-management,maintenance", "version": "0.1.0", "category": "Writing", "displayName": "Docs Release Maintenance" }
description
Manage developer documentation release, publishing, ownership, freshness, automation, maintenance, SaaS cadence, deprecation, deletion, redirects, and migration alongside software changes. Use when planning docs for a release, defining docs ownership, creating publishing checklists, setting up freshness checks, refreshing existing content, documenting SaaS releases, or retiring stale documentation.
compatibility
Codex, Claude Code, and other Agent Skills-compatible clients.

02 资源文件 4

03 SKILL.md 正文

Docs Release Maintenance

Use this skill to keep developer documentation aligned with software release and maintenance lifecycles. It covers publishing readiness, ownership, automation, freshness, and responsible deprecation or deletion.

This skill is derived from Docs for Developers: An Engineer's Field Guide to Technical Writing, especially Chapter 7, "Publishing documentation," and Chapter 11, "Maintaining and deprecating documentation." It is expanded with paraphrased guidance from Christopher Gales and the Splunk Documentation Team's The Product Is Docs: Writing Technical Documentation in a Product Development Group, especially Chapter 10, "Maintaining Existing Content," Chapter 25, "Writing SaaS Documentation," and Chapter 2, "Agile." Do not copy book prose into user outputs. Source: https://link.springer.com/book/10.1007/978-1-4842-7217-6

Quick Start

  1. Load guidelines.md to choose the smallest useful reference set.
  2. Identify the release, affected users, docs owners, source of truth, and publication path.
  3. Use workflows/plan-doc-release-maintenance.md for release or maintenance planning.
  4. Use workflows/refresh-existing-docs.md when stale content, patch buildup, or dependency updates require a focused refresh.
  5. Align doc publication, review, testing, announcement, and deprecation with code changes.
  6. Prefer automation that removes known toil; do not automate an unclear process.

Default Output

When planning release or maintenance work, return:

  1. Release or maintenance scope - code/product change and affected docs.
  2. User impact - who is affected and what action they need.
  3. Publishing checklist - owner, reviewers, approval, tests, delivery, announcement.
  4. Maintenance plan - owners, freshness checks, link checks, linting, generated references.
  5. Deprecation or deletion plan - warnings, alternatives, migration guide, redirects, and timing.
  6. Risks and blockers - unverified facts, missing owners, or automation gaps.

Contents

Need Start Here
Understand release and maintenance concepts references/core/knowledge.md
Apply lifecycle rules references/core/knowledge.md
See checklist examples references/core/knowledge.md
Plan release, maintenance, or deprecation workflows/plan-doc-release-maintenance.md
Refresh existing docs workflows/refresh-existing-docs.md
Route by task guidelines.md

Core Posture

  • Docs should ship with the software change they explain.
  • Every maintained doc needs ownership or an authoritative source.
  • Automation should follow a understood manual process.
  • Maintenance work should assess scope before patching content.
  • Deprecation and deletion are user communication problems, not just cleanup tasks.

04 同仓库更多 Skills

hashgraph-online
hashgraph-online/awesome-codex-plugins

worktable-review-with-annotations

Create, inspect, reply to, update, or resolve situated Worktable annotations. Use when feedback belongs to a Doc section, block, text range, or HTML Doc, or when the user asks to address existing review feedback and coordinate a requested artifact edit.

★ 1.6k
hashgraph-online
hashgraph-online/awesome-codex-plugins

worktable-find-and-synthesize-context

Find, assess, and synthesize context from Worktable Docs and Records. Use when the user asks what a workspace contains, wants workspace-backed research, needs current facts reconciled across artifacts, or requests a cited synthesis without changing workspace state.

★ 1.6k
hashgraph-online
hashgraph-online/awesome-codex-plugins

worktable-create-or-update-docs

Create, edit, rename, or maintain narrative Worktable Docs. Use for plans, decisions, briefs, notes, research syntheses, and other durable prose when the user requests a new artifact or a safe update to an existing one.

★ 1.6k
hashgraph-online
hashgraph-online/awesome-codex-plugins

worktable-create-or-manage-records

Organize repeated structured information as durable Worktable Records. Use for research datasets, inventories, directories, pipelines, trackers, and other collections whose items need identity, fields, filtering, links, validation, or individual updates.

★ 1.6k
hashgraph-online
hashgraph-online/awesome-codex-plugins

worktable-create-or-manage-interactive-html

Create or improve durable visual and interactive artifacts in Worktable. Use for dashboards, trackers, calculators, mini apps, slide presentations, and other requests that benefit from a polished HTML Doc.

★ 1.6k
hashgraph-online
hashgraph-online/awesome-codex-plugins

worktable-collaborate-threads

Read, answer, and hand off messages through durable Worktable threads with users or other authenticated participants. Use when the user asks to check addressed messages, reply to a participant, continue a thread, request another agent's help, wait briefly for a response, or watch for comments and messages sent to the agent.

★ 1.6k