跳到正文
cccskills
免费在 GitHub 公开

codexkit-docs-shipper

Update README, migration notes, changelogs, and operator-facing docs so shipped changes remain understandable after release.

中文简介正在准备中。当前显示原文说明。

查看安装方法

包含的文件(4)

  • SKILL.md1.9 KB
  • agents/openai.yaml215 B
  • templates/changelog-template.md985 B
  • templates/readme-template.md1.2 KB

SKILL.md(原文)

安装前可以查看交给 AI 代理的指令内容。

Docs Shipper

Use this skill when product or engineering changes alter how a repo is used, run, configured, or released.

Workflow

  1. Identify which audience is affected: contributor, operator, end user, or reviewer.
  2. Update the smallest docs surface that prevents confusion.
  3. Prefer runnable examples and concrete file paths.
  4. Add change notes when the public surface changed.
  5. Flag unresolved docs debt instead of pretending the docs are complete.

Outputs

  • changed docs list
  • short explanation of what was updated
  • follow-up docs gaps if any remain

Quality Criteria

  • Feedback is specific and references exact locations in the reviewed material
  • Each critique includes a concrete improvement suggestion
  • Severity is categorized (critical / important / nice-to-have)
  • Positive aspects are acknowledged alongside areas for improvement

Verification (4C)

CheckQuestion
CorrectnessIs the feedback technically accurate and properly contextualized?
CompletenessWere all major sections of the reviewed material addressed?
Context-fitIs the review granularity appropriate for the material's maturity level?
ConsequenceIf the author implemented all feedback literally, what could go wrong?

Edge Cases

  • Material is too early-stage for detailed review — Provide structural feedback only. Note that content review is deferred until it matures.
  • Reviewer lacks domain expertise — Focus on structure, clarity, and consistency. Flag domain-specific claims as 'Needs SME verification'.
  • Author is defensive or resistant to feedback — Lead with what works well. Frame changes as questions rather than mandates.

Changelog

  • v1.0.0 — Initial release

评价

还没有评价。欢迎分享你的使用感受。

评论

无需登录即可发表。欢迎分享使用感受、提问,或说明在哪些环境下无法运行。

还没有评论。来写第一条吧。

提交后会立即公开。请勿填写邮箱、电话等个人信息。URL 最多 2 个。

0 / 1000 字

此表单受 reCAPTCHA 保护,适用 Google 的隐私权政策和服务条款。

同一仓库的技能

Design rigorous A/B test plans with hypothesis, sample size calculation, Minimum Detectable Effect (MDE), randomization strategy, and decision rules. Includes guardrail metrics and rollout playbook. Use when planning product experiments, conversion optimization, or data-driven feature decisions.

中文简介正在准备中。当前显示原文说明。

hoavdc/CodexKit252026年10月11日 更新

Review REST and GraphQL API designs for consistency, usability, and best practices. Covers naming conventions, versioning strategy, error format, pagination, authentication patterns, and breaking change detection. Use when reviewing API specs, designing new APIs, or auditing existing endpoints.

中文简介正在准备中。当前显示原文说明。

hoavdc/CodexKit252026年10月11日 更新

Write Architecture Decision Records (ADRs) following the Michael Nygard format. Captures context, options considered, decision rationale, and consequences. Use when making technology choices, framework selections, or any architectural decision that future developers need to understand.

中文简介正在准备中。当前显示原文说明。

hoavdc/CodexKit252026年10月11日 更新

Assess organizational readiness for financial audits (internal or external). Map assertions to account balances, check evidence completeness, score readiness using a Red/Amber/Green framework, and generate a remediation timeline. Aligned with SOX, IFRS, and GAAP audit standards. Use before scheduled audits or when preparing for first-time compliance.

中文简介正在准备中。当前显示原文说明。

hoavdc/CodexKit252026年10月11日 更新

Design safe recurring Codex automations with clear prompts, outputs, schedules, and gating rules.

中文简介正在准备中。当前显示原文说明。

hoavdc/CodexKit252026年10月11日 更新

Refine Product Backlog Items to meet INVEST criteria. Write User Stories with Acceptance Criteria in Given/When/Then format, estimate with Story Points, and flag dependencies. Use before sprint planning when backlog items need grooming. Do not use to prioritize the backlog — that is the Product Owner's decision.

中文简介正在准备中。当前显示原文说明。

hoavdc/CodexKit252026年10月11日 更新

查看 hoavdc 的全部技能

报告此技能的问题