無料GitHub で公開日本語紹介

document

READMEや利用ガイド、API仕様、移行手順など、リポジトリや製品の文書を作成・更新するスキル。読者と掲載先を確認し、コマンドやパスの正確さも確かめます。

原文原文の説明を見る

Write or update repository/product documentation: README, user guides, API docs, architecture, migration notes, and changelog material. This is not the Word-document artifact skill.

codewhale-hq/Codewhale

インストール方法を見る

こんなときに便利

READMEや利用ガイドを更新したいとき
APIやシステム構成の文書作成
移行手順を文書にまとめたいとき
変更履歴の説明を追加したいとき

日本語での紹介

できること

リポジトリや製品についての説明文書を作成・更新します。対象はREADME、利用ガイド、APIドキュメント、システム構成の説明、移行に関する案内、変更履歴の記載です。文書を読む人と掲載先を確認し、既存の文書を更新する方法を優先します。記載するコマンドやパスは確かめ、不明な点は推測で埋めずに明示します。

こんなときに便利

製品の使い方を読者に合わせて説明したいときや、機能や構成の変更に合わせて文書を直したいときに向いています。新しい文書を追加する前に、既存のREADMEやガイドへ反映できるかを確認したい場合にも使えます。移行時に必要な案内や、変更履歴に載せる説明を整える用途も対象です。

使い方の例

「初めて使う人向けに、既存のREADMEを更新して」
「このAPIの説明を追加し、コマンドとパスを確認して」
「移行手順と変更履歴に載せる文章を作って。不明点は明示して」

注意点

対象はリポジトリや製品のドキュメントです。Word／DOCX形式の文書作成は対象外で、docxを使う案内になっています。リリースの公開作業も含まれず、明示的に依頼された場合にreleaseを使います。

この紹介文は、公開されている SKILL.md をもとに AI（OpenAI Codex）が作成しました。正確な仕様は下の原文を確認してください。

含まれるファイル（1）

SKILL.md677 B

SKILL.md（原文）

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

Document

When to use

Use for repo/product docs: README, guides, API docs, architecture, migrations, changelog notes.

Non-goals

Not Word/DOCX authoring (use docx).
Not release publication (use release only when explicit).

Workflow

Identify the doc audience and location.
Prefer updating existing docs over creating duplicates.
Keep commands and paths verified.
Call out unknowns instead of inventing them.

レビュー

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

同じリポジトリのスキル

概要と使いどころ