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

readme-writer

Use this skill to write or revise a README.md for a Shipfox workspace package (libs/*, tools/*). It applies the shared package README standard and repository prose policy. Trigger on write a README, draft README, rewrite README, document this package, or improve the README.

インストール方法を見る

含まれるファイル(1)

  • SKILL.md2.1 KB

SKILL.md(原文)

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

README Writer

Use this workflow to document one package. It does not apply to the repository root README, design documents, or RFCs.

Before drafting a package README, read the package README standard. It owns the required structure, prose style, public-surface rules, development guidance, and license section for human and agent authors.

When deciding whether detail belongs in the package README, read the engineering documentation map. It owns documentation placement and canonical ownership.

Gather the package contract

Read the public package surface in this order:

  1. package.json for its name, exports, binaries, scripts, and dependencies.
  2. The root export entry point for consumer-visible symbols.
  3. Additional source files only as needed to understand those exports.
  4. A sibling *-dto package when it owns public DTO or event names.
  5. drizzle/ or migrations/ when the package owns persistent data.

Do not document symbols that the package does not export or ship.

Workflow

  1. Apply the package README standard, including only the sections that fit the package.
  2. Use the inspected public contract for the package description, setup, and runnable usage example. Link to schemas or configuration sources instead of copying fast-changing values.
  3. Check nearby package READMEs only for local conventions or comparable examples. They do not override the shared standard.
  4. Run mise exec -- turbo verify --filter=@shipfox/prose-policy and review its warnings and suggestions for the README.
  5. Apply the guidance in WRITING.md to improve the result, then reread the README as a package consumer.

Report the public sources inspected, the sections included, and the prose-policy result.

レビュー

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

同じリポジトリのスキル

概要と使いどころ

commit

無料

ALWAYS use this skill when committing changes. Applies Shipfox agent sequencing for branch checks, scoped validation, and commit creation. Trigger on commit, commit changes, save changes, make a commit, or create commit.

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

ShipfoxHQ/shipfox272026年10月13日 更新

Use when setting up a Shipfox workflow from a template.

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

ShipfoxHQ/shipfox272026年10月13日 更新

Use when diagnosing a failed or stalled Shipfox workflow run, or an event that did not start one.

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

ShipfoxHQ/shipfox272026年10月13日 更新

Generate a Changeset file for the current branch using Shipfox agent automation. Trigger when the user asks to add a Changeset, document a change for release, bump versions, or prepare a PR that touches published packages.

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

ShipfoxHQ/shipfox272026年10月13日 更新

Use when the user wants to design, redesign, shape, critique, audit, polish, clarify, distill, harden, optimize, adapt, animate, colorize, extract, or otherwise improve a frontend interface. Covers websites, landing pages, dashboards, product UI, app shells, components, forms, settings, onboarding, and empty states. Handles UX review, visual hierarchy, information architecture, cognitive load, accessibility, performance, responsive behavior, theming, anti-patterns, typography, fonts, spacing, layout, alignment, color, motion, micro-interactions, UX copy, error states, edge cases, i18n, and reusable design systems or tokens. Also use for bland designs that need to become bolder or more delightful, loud designs that should become quieter, live browser iteration on UI elements, or ambitious visual effects that should feel technically extraordinary. Not for backend-only or non-UI tasks.

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

ShipfoxHQ/shipfox272026年10月13日 更新

pr

無料

ALWAYS use this skill when creating pull requests. Applies Shipfox agent sequencing for GitHub CLI review preparation and pull-request creation. Trigger on create PR, open PR, submit PR, make PR, push and create PR, or prepare changes for review.

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

ShipfoxHQ/shipfox272026年10月13日 更新

ShipfoxHQ のスキルをすべて見る

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