readme-writer

스타13

포크0

업데이트2026년 7월 22일 22:20

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 runs the repository readability check. Trigger on write a README, draft README, rewrite README, document this package, or improve the README.

설치

Codex 또는 Claude로 설치 이 Prompt를 복사해 Codex, Claude 또는 다른 어시스턴트에 붙여 넣으면 Skill 페이지를 검토하고 설치를 진행할 수 있습니다.

출처

ShipfoxHQ

ShipfoxHQ/shipfox

GitHub 저장소 열기 Creator 저장소 보기

다운로드

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:

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

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

Workflow

Apply the package README standard, including only the sections that fit the package.
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.
Check nearby package READMEs only for local conventions or comparable examples. They do not override the shared standard.
Run the repository readability check:

node .agents/skills/readme-writer/scripts/readability.mjs <path-to-README.md>

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 readability result.

이 저장소의 다른 Skills

같은 저장소

ShipfoxHQ/shipfox

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.

2026-07-2313

commit

ShipfoxHQ/shipfox

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.

2026-07-2213

generate-changeset

ShipfoxHQ/shipfox

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.

2026-07-2213

name	readme-writer
description	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 runs the repository readability check. Trigger on write a README, draft README, rewrite README, document this package, or improve the README.
allowed-tools	Read, Write, Edit, Glob, Grep, Bash

README Writer

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

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:

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

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

Workflow

Apply the package README standard, including only the sections that fit the package.
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.
Check nearby package READMEs only for local conventions or comparable examples. They do not override the shared standard.
Run the repository readability check:

node .agents/skills/readme-writer/scripts/readability.mjs <path-to-README.md>

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 readability result.