kierangao/general-readme-skill
Developer toolsこのページは AI により自動翻訳されています。技術的な詳細は原文をご確認ください。 原文を見る
使用 AI の指導助手は、AI アシスタント スキルを使用して任意のプロジェクトのための README 文件を生成します.
概要
一般的なREADMEスキルは、AIコーディングアシスタントゼロの依存性・マルチプラットフォーム・マルチ言語・Claudeコード、Copilot、Cursorなどを使用したあらゆるプロジェクトでプロフェッショナルなREADMEファイルを生成します。 生成前に設定オプションを収集します。 すべてのオプションにはデフォルト値が固定されています。 - (デフォルト:英語) - (オプション:中国語、日本語、韓国語、スペイン語、フランス語、ロシア語など) 組み込みツールを使用して、ローカルプロジェクトディレクトリをスキャンします。 Node.js の典型的なプロジェクトでは、package.json を使用します。 参照ファイルをロードし、(変換されたピラミッド)続くコンテンツを生成します。 参照/フォルダにあるすべての参照: bash npm インストール my-package bash cp .env.example .env bash npm run dev `
概要（AI 翻訳）
一般的なREADMEスキル
AI コーディングアシスタントでエビデンスベースの README ファイルを作成および更新
v2.0.0・環境設定の確認・Git-Aware Update・マルチプラットフォーム・マルチ言語
日本語・英語・中国語・簡体字・繁体字
クイックスタート
このリポジトリ([general-readme-skill)は2つのスキルを提供します:[readme-write READMEファイルと**readme-update]**は、Gitの変更から電流を保ちます。 コアワークフローは、ネイティブエージェントの読み込み/検索/編集ツールを使用します。 オプションのオフラインチェッカーは、Python 3.9+ とサードパーティのパッケージを必要としません。
インストール readme-write
[SKILL.md, references/], [scripts/]]をコピーして、[readme-writeというスキルディレクトリにまとめます。 相対パスを不当に保って下さい;SKILL.mdだけを取付けて下さい]はワークフローの不完全を残します。
別のターゲットプロジェクトでは、プロジェクトの絶対的なスキルディレクトリを目的地として使用し、既存のチームの指示を上書きしません。 統合ガイド: クロードコード、GitHub Copilot、Cursorを参照してください。 それらはファイル配置を記述します; ホストのローディングは、インストールされたホストで検証する必要があります.
このページは AI により自動翻訳されています。技術的な詳細は原文をご確認ください。
README
以下は原文 README の抜粋です。原文を見る。
General README Skill
Create and update evidence-based README files with AI coding assistants
v2.0.0 · Preference Confirmation · Git-Aware Updates · Multi-Platform · Multi-Language
English · 中文 · 日本語 · 한국어 · Русский
Quick Start
This repository (directory general-readme-skill) provides two skills: readme-write creates README files and readme-update keeps them current from Git changes. The core workflow uses native agent read/search/edit tools. The optional offline checkers need Python 3.9+ and no third-party packages.
Install readme-write
Copy SKILL.md, references/ and scripts/ together into a skill directory named readme-write. Keep their relative paths intact; installing only SKILL.md leaves the workflow incomplete.
mkdir -p .claude/skills/readme-write
cp SKILL.md .claude/skills/readme-write/
cp -r references/ scripts/ .claude/skills/readme-write/
For another target project, use that project’s absolute skill directory as the destination and do not overwrite existing team instructions. See the integration guides: Claude Code, GitHub Copilot, Cursor. They describe file placement; host loading must be verified in the installed host. Natural-language invocation is the portable option; /readme-write and /readme are trigger phrases, not guaranteed slash commands.
Get the first result
Ask the host agent:
Write a README for this project
The first response bundles the unresolved preferences and stops until you answer. Reply with your choices or “use the recommended settings”. After acceptance, the agent inspects static project evidence, writes the agreed README files, and reports what was checked.
To delegate choices explicitly:
推奨ツール
別のキーワードを試すか、フィルタを外してください。
インストール
npx skillfish add kierangao/general-readme-skill