メニュー
Use this skill when creating or updating a README file. Covers the funnel structure (What → Why → Install → How), keeping it concise, and separating concerns into dedicated files (CONTRIBUTING.md, CHANGELOG.md).
Codex または Claude でインストール この Prompt をコピーして Codex、Claude、または他のアシスタントに貼り付けると、Skill ページを確認してインストールできます。
SOC 職業分類に基づく
Agent guide for running GPU experiments and serverless model deployments with the jl CLI on JarvisLabs.ai.
設計・アーキテクチャの壁打ちを Codex MCP (GPT) と行う。 実装前の方針検討、トレードオフ分析、API 設計の相談に使う。 "codex discuss", "GPTと相談", "壁打ち", "設計を議論" などで呼び出す。
git diff ベースのコードレビューを Codex (GPT) に依頼する。 コード変更後にセカンドオピニオンが欲しいとき、"codex review", "GPTにレビューして", "セカンドオピニオン" などで呼び出す。実体は公式プラグイン codex@openai-codex に 移行済みで、本 skill は自然文トリガーの受け皿 (誘導シム)。
実装・レビュー (Codex MCP / GPT)・修正の反復ループ。 ユーザーの意図する機能が動くこと (= 機能ゲート pass) と Codex の LGTM を AND で満たすまで回す。 タスク説明 / plan ファイル / 既存 diff のいずれを起点にしてもよい。 実装フェーズは Karpathy 4 原則 (think before / simplicity / surgical / goal-driven) に従う。 "lgtm loop", "LGTMまで回す", "実装してレビューして直して", "実装と修正をループで" などで呼び出す。
生成・編集した視覚成果物（Web ページ URL、ローカルの HTML/UI ファイル、 画像・図・PDF/SVG）をスクリーンショットで取得し、Read で実際に見て チェックリスト採点する。崩れ・はみ出し・重なり・コントラスト不足を検出し、 NG なら具体的な修正案を返す。Max プランの画像認識を惜しまず使うための専用コマンド。
人間が読む長めの文章・レポート・ドキュメント・資料を生成するときに使用する。単一の HTML ファイル (+ 必要なら assets/) として出力し、Markdown が 100 行を超えると読まれなくなる問題を sticky TOC・構造化 callout・優先度 pill・数式 (KaTeX)・コードハイライト (Prism)・D2 ダイアグラム・チャート (matplotlib SVG) で解決する。技術分析・応用検討・設計レポート・選択肢比較・サーベイ・議論ログ (Codex 等の第二視点を取り込む review-log 型) など、500 字を超える / 図表を伴う / 改訂を重ねる文書には必ず使用する。"レポート", "ドキュメント", "資料", "サーベイ", "技術レポート", "HTMLレポート", "応用検討", "選択肢比較", "議論ログ", "review log", "Codex レビュー反復" などのトリガーで発動する。
| name | readme-writing |
| description | Use this skill when creating or updating a README file. Covers the funnel structure (What → Why → Install → How), keeping it concise, and separating concerns into dedicated files (CONTRIBUTING.md, CHANGELOG.md). |
| user-invocable | true |
出典: MIT Missing Semester 2026 - Beyond the Code 参考: fantoccini, HdrHistogram_rust, loguru
READMEはファネル（漏斗）構造で書く。 上から順に読んで、必要な段階で離脱できるようにする。 読者の時間を尊重し、最小限の情報で判断できるようにする。
# プロジェクト名 ← 1行キャッチフレーズ（What）
[バッジ行] ← CI / version / license / coverage（任意）
[ビジュアルデモ] ← スクリーンショット / GIF / 端末出力（任意）
## Installation ← すぐ試せるように短く
## Usage / Quick Start ← コード例主体、段階的に複雑化
## Features（任意） ← 量が多いプロジェクト向け
## Contributing（短く） ← 詳細は CONTRIBUTING.md へ
## License ← 1行 + LICENSE ファイルへのリンク
独立した「Why」セクションは不要な場合が多い。冒頭の1行説明やイントロ段落に 「何を解決するか」を自然に織り込む方が、実際のOSSプロジェクトでは一般的。
H1タイトルの直後に、1〜2文で「これは何か」を示す。
冒頭の記載例:
# fantoccini
A high-level API for programmatically interacting with web pages
through WebDriver.
# loguru
Python logging made (stupidly) simple.
プロジェクト名だけで伝わらない場合は、対象ユーザーや解決する課題を含める。 可能ならビジュアルデモ（スクリーンショット、GIF、端末出力）を添える。
バッジは冒頭またはタイトル直下にまとめる。よく使われるもの:
[](https://crates.io/crates/fantoccini)
[](https://docs.rs/fantoccini/)
[](https://codecov.io/gh/jonhoo/fantoccini)
バッジは3〜5個程度に抑える。多すぎると視認性が落ちる。
短く。コピー&ペーストで完了する形にする。
## Installation
```bash
pip install loguru
前提条件がある場合は箇条書きで添える:
```markdown
Requirements: git, curl
コード例を主体にする。 説明文で語るより、動くコードを見せる。
段階的に複雑化させる（loguru方式）:
## Usage
基本的な使い方:
```python
from loguru import logger
logger.debug("That's it, beautiful and simple logging!")
ファイル出力:
logger.add("file_{time}.log")
ローテーション:
logger.add("file.log", rotation="500 MB")
logger.add("file.log", rotation="12:00")
複数の例を出す場合は、シンプルなものから始めて徐々に高度にする。
各コード例には1〜2行の説明を付けると理解しやすい。
### 5. Features（任意）
機能が多いプロジェクトでは、各機能を独立したサブセクションにし、
それぞれにコード例を付ける（loguru方式が好例）。
機能が少ないプロジェクトでは Usage に統合してよい。
### 6. 設計判断・制限事項（任意）
「なぜこうしたか」を明示すると、ユーザーがプロジェクトの適合性を判断しやすい。
```markdown
## Design decisions
- Uses quantiles `[0,1]` instead of percentiles `[0,100]`
to minimize floating-point precision loss
- Safe functions return `Result`; operator overloads panic on error
未実装機能や既知の制限も正直に書く（HdrHistogram_rust方式）。
README内では短く。詳細は CONTRIBUTING.md に分離する。
## Contributing
See [CONTRIBUTING.md](CONTRIBUTING.md) for details.
テストの実行方法だけREADMEに書くパターンも有効:
## Contributing
```bash
chromedriver &
geckodriver &
cargo test
### 8. License
1行 + ファイルリンク。デュアルライセンスの場合も簡潔に。
```markdown
## License
Licensed under either of [Apache License, Version 2.0](LICENSE-APACHE)
or [MIT license](LICENSE-MIT) at your option.
| 内容 | ファイル | 理由 |
|---|---|---|
| 貢献ガイド | CONTRIBUTING.md | 対象読者が限定的 |
| 変更履歴 | CHANGELOG.md | 量が増え続ける |
| アーキテクチャ | docs/ | 開発者向け詳細情報 |
| API仕様 | docs/ または自動生成 | READMEに書くと古くなる |
| FAQ | FAQ.md または docs/ | 量が多ければ分離 |