本文へ移動
cccskills
無料GitHub で公開

documenting-release

Cross-reference diffs to update README, ARCHITECTURE, CHANGELOG.

インストール方法を見る

含まれるファイル(1)

  • SKILL.md1.9 KB

SKILL.md(原文)

インストールする前に、エージェントに与えられる指示の中身を確認できます。

Documenting Release

Role Constraints: Lead (Write/Bash access allowed). File Access: Do NOT use literal placeholders for file paths. Use the glob tool to search for the active feature directory under .jonggrang/.output/features/.

Objective

Ensure every documentation file in the project is accurate, up to date, and written in a friendly, user-forward voice before the feature is fully released.

Execution Steps

  1. Pre-flight & Diff Analysis:
    • Use bash to run git diff main...HEAD --stat (or the appropriate base branch) to understand what changed.
    • Classify changes into features, changed behavior, removals, and infrastructure.
  2. Per-File Documentation Audit:
    • Locate major documentation files (README.md, ARCHITECTURE.md, CHANGELOG.md, CONTRIBUTING.md) using glob.
    • Read each file and cross-reference it against the git diff.
  3. Apply Factual Updates:
    • Use the edit or write tool to make factual corrections directly (e.g., adding a command to a table, updating counts).
    • Use the bash tool if you need to run specific scripts that generate documentation.
  4. CHANGELOG Voice Polish:
    • If CHANGELOG.md exists, review the entry for the current feature.
    • Polish the wording to focus on user capabilities ("You can now...") rather than implementation details. Do NOT delete or regenerate existing entries, only refine them.
  5. Ask About Risky Changes:
    • If narrative changes, security model descriptions, or massive rewrites are needed, ask the user for confirmation before proceeding.
  6. Cross-Doc Consistency Check:
    • Ensure the README aligns with ARCHITECTURE and CHANGELOG. Fix any clear factual inconsistencies.

Completion Signal

When the documentation has been updated and verified, output exactly:

DOCUMENTATION_COMPLETE

レビュー

まだレビューはありません。使ってみた感想をお寄せください。

同じリポジトリのスキル

概要と使いどころ

anoa

無料

Drive a real browser from the command line — open pages, snapshot the interactive elements as refs, click and fill by ref, read text, run JS, screenshot. Use when a task needs a live browser: checking a page renders, walking a login or checkout flow, scraping something that only exists after JavaScript runs, or reproducing a UI bug.

日本語の概要は準備中です。原文の説明を表示しています。

porcupine-md/jonggrang152026年9月15日 更新

Run linters/typecheckers to calculate health score.

日本語の概要は準備中です。原文の説明を表示しています。

porcupine-md/jonggrang152026年9月15日 更新

Comprehensive UI/UX compliance check (A11y, performance, responsive).

日本語の概要は準備中です。原文の説明を表示しています。

porcupine-md/jonggrang152026年9月15日 更新

Infrastructure-first security audit (OWASP, secrets, dependencies).

日本語の概要は準備中です。原文の説明を表示しています。

porcupine-md/jonggrang152026年9月15日 更新

auth

無料

Setup authentication flow (register, login, session/JWT, middleware)

日本語の概要は準備中です。原文の説明を表示しています。

porcupine-md/jonggrang152026年9月15日 更新

Deep knowledge about deploying applications to AWS (EC2, ECS, S3, CloudFront, Cloud Run).

日本語の概要は準備中です。原文の説明を表示しています。

porcupine-md/jonggrang152026年9月15日 更新

porcupine-md のスキルをすべて見る

このスキルの問題を報告する