🇺🇸 GitHub README Writing System — Craft a README that converts visitors to stars in <3 seconds. Proven structure from AFFiNE's 0→60K star journey: tagline engineering, first-screen law, section-by-section copywriting guide, Claude Code integration section, anti-patterns, and a pre-publish checklist. Use when you need to write or rewrite a specific README file. 🇨🇳 GitHub README 写作系统 — 打造 3 秒内把访客转化为 star 的 README。来自 AFFiNE 0→60K star 实战：tagline 工程、首屏法则、逐节文案指南、Claude Code 集成板块、反模式、发布前自检清单。需要写或改一个具体 README 文件时使用。 🇯🇵 GitHub README 作成システム — 3秒以内にビジターをスターに変えるREADMEを作る。AFFiNE 0→60Kスター実績から: タグライン設計、ファーストスクリーン法則、セクション別ライティングガイド、Claude Codeインテグレーション、アンチパターン、公開前チェックリスト。 🇰🇷 GitHub README 작성 시스템 — 3초 안에 방문자를 스타로 전환하는 README 작성법. AFFiNE 0→60K 스타 실전: 태그라인 설계, 첫 화면 법칙, 섹션별 카피라이팅 가이드, Claude Code 통합 섹션, 안티패턴, 게시 전 체크리스트. Triggers: "write README" | "README template" | "GitHub README" | "project description" | "tagline" | "open source README" | "README structure" | "README review" | "fix README" | "rewrite README" | "README写作" | "写README" | "README模板" | "项目介绍" | "开源项目文案" | "改README" | "README检查" | "README 구조" | "README 작성" | "README 검토" | "READMEの書き方" | "READMEレビュー"
「readme」の検索結果
454 件 ・ 関連度順
概要と使いどころ
Generate or redesign evidence-based README files for apps, libraries, CLIs, monorepos, and agent skills. This skill should be used for /readme-write, /readme, generate readme, write readme, improve readme, 帮我写 README, 美化 README, README を書いて, README 작성해 줘, напиши README, or their equivalents in any language. Confirm reader and visual preferences before generation; every README includes a source-backed flowchart, and every language edition keeps identical content apart from the language. Git-driven updates are routed to the companion readme-update skill.
Synchronize existing READMEs with local Git code changes and every language edition. This skill should be used for update readme, sync readme, 更新 README, 更新项目文档, 同步多语言 README, README を更新して, README 업데이트해 줘, обнови README, or /readme-update. Ask for an exact project version or explicit unchanged choice before editing; inspect committed, staged, unstaged and untracked changes, weave each change into its natural position (never just the beginning or end), keep the flowchart current, and keep all language editions identical apart from the language.
GitHub OSS向け README.md の作成・改善・レビューを支援する。What/Why/How to start/Help/Maintainers の軸で情報を整理し、最短で動かせる Quickstart と docs への導線を構成する。 READMEの新規作成、既存READMEの再構成、READMEレビュー、ドキュメント分割の判断時に使用する。 トリガー：「READMEを作って」「READMEを改善して」「Quickstartを追加して」 「GitHub向けREADMEテンプレ」「READMEをレビューして」などのREADME関連リクエスト。
Create polished shieldcn README badges, badge groups, charts, headers, sponsors grids, and full README hero sections. Use when a user wants shadcn/ui-styled badges, Shields.io replacement, npm/GitHub/CI/status badges, download charts, README header banners, contributor/sponsor images, or README Studio guidance. Triggers include "add badges", "add shields", "README badges", "npm badge", "GitHub stars badge", "CI badge", "download chart", "README header", "README banner", "contributors grid", "sponsors grid", "build a README", "README Studio", "shieldcn", and requests to make a project README look better.
日本語の概要は準備中です。原文の説明を表示しています。
ローカルにある複数のAI開発エージェントのログを集計し、トークン数やAPI換算費用をSVGカードにします。READMEや資料に載せる利用状況をまとめられます。
- READMEにエージェント利用状況を掲載
- 複数エージェントの活動を共有したいとき
- トークン数とAPI換算費用の可視化
Review a codebase and generate or update its README.md according to best practices. The skill performs static analysis of the project structure, dependencies, scripts, and existing documentation, then produces a comprehensive, accurate README. **Triggers — use this skill when:** - User asks to "review", "update", "improve", or "generate" a README - User says "create a README for this project" - User mentions "document this repo", "add documentation" - User asks to "fix my README" or "make my README better" - User provides a codebase and asks for documentation help **Covers:** Any project type — Node.js, Python, Rust, Go, Java, Ruby, PHP, monorepos, static sites, CLI tools, libraries, APIs, Docker-based projects, and more. Works with both new READMEs (from scratch) and existing ones (update/improve).
日本語の概要は準備中です。原文の説明を表示しています。
🇺🇸 Open-Source Marketing & GitHub Stars Growth System — Decision framework for each growth stage. Pre-launch readiness → Show HN / Reddit / Product Hunt launch → 6-month growth loop. README rules, KOL outreach, dev-content matrix (dev.to / Zenn), anti-star-farming. Built from taking AFFiNE 0 → 60K stars. 🇨🇳 开源营销与 GitHub Star 增长系统 — 每个增长阶段的决策框架。Pre-launch 就绪 → Show HN / Reddit / Product Hunt 发布 → 6 个月增长循环。README 规则、KOL 合作、开发者内容矩阵（dev.to / Zenn）、防刷 star。提炼自 AFFiNE 0 → 60K star 实战。 🇯🇵 オープンソースマーケティング＆GitHub スター成長システム — 各成長段階の意思決定フレームワーク。Pre-launch → Show HN / Reddit / Product Hunt → 6ヶ月成長ループ。READMEルール、KOL連携、開発者コンテンツマトリックス。 🇰🇷 오픈소스 마케팅 & GitHub 스타 성장 시스템 — 각 성장 단계별 의사결정 프레임워크. 사전 출시 → Show HN / Reddit / Product Hunt → 6개월 성장 루프. README 규칙, KOL 아웃리치, 개발자 콘텐츠 매트릭스. Triggers: "open source marketing" | "GitHub stars" | "star growth" | "Show HN" | "Hacker News launch" | "OSS launch" | "developer marketing" | "Reddit launch" | "dev.to" | "open source growth" | "开源营销" | "GitHub star 增长" | "开源发布" | "Show HN 怎么发" | "开发者营销" | "オープンソース" | "오픈소스 성장"
Generates professional PyPI-compliant README files in Markdown or reStructuredText. Use when creating a Python package README for PyPI publication, converting between README.md and README.rst formats, validating markup with twine check before publishing, configuring the readme field in pyproject.toml, integrating sphinx-readme to generate PyPI-compatible RST from Sphinx docs, troubleshooting rendering errors on PyPI, or previewing README rendering locally with grip or docutils.
日本語の概要は準備中です。原文の説明を表示しています。
Update an EXISTING Tip in the ai-product-dev-tips repository — edit its README, add or fix code, refresh outdated information, fix mistakes — while keeping the repo's format conventions and syncing the root README link. Use this whenever the user wants to update, edit, fix, revise, refresh, correct, or complete an existing Tip in this repo — e.g. "nlp_processing/29 の README を更新して", "〇〇の Tip を最新仕様に直して", "image_processing/11 の説明を修正して", "あの Tip のリンク切れを直して", "この Tip を完成版にして". It locates the target Tip, studies the current format conventions (shared with the ai-product-dev-tips-create skill), applies consistent edits, verifies the content with web research (no fabrication), and syncs the root README link (title text / [In-progress]). This is for UPDATING existing Tips, not creating new ones — to add a brand-new Tip use the ai-product-dev-tips-create skill instead. Trigger this even if the user doesn't say "skill".
Update the root README.md with entries for new or changed agent companies. Use when a new company has been added to the repo, when company details have changed (agents added/removed, skills added/removed), or when the user asks to refresh/sync the README. Triggers on: "update the readme", "add this company to the readme", "sync readme", "refresh readme", or after creating a new company with company-creator.
日本語の概要は準備中です。原文の説明を表示しています。
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.
日本語の概要は準備中です。原文の説明を表示しています。
技術文書やエージェント向け指示ファイルを作成・レビューするスキル。READMEや貢献手順も調べ、説明の分かりやすさ、運用上の整合性、多言語版の差分を確認します。
- 技術文書を作成・更新したいとき
- READMEや文書の変更レビュー
- エージェント指示と貢献手順の整備
Redesign GitHub README homepages or create project-native pure SVG, hybrid SVG-composed PNG/WebP, and opt-in animated GIF assets. Use when a user asks to beautify, redesign, rebrand, visually upgrade, simplify, or audit a GitHub README; create only a hero, section headers, diagrams, badges, motion graphics, showcase modules, or other README assets; or turn a repository homepage into a cohesive visual story. If whole-README work versus asset-only work is unclear, ask which scope the user wants. For hero-like assets where pure SVG and generated raster material are both viable, explain the tradeoffs and confirm the implementation before creating the asset.
日本語の概要は準備中です。原文の説明を表示しています。
Scaffold a new Tip in the ai-product-dev-tips repository following the existing directory/format conventions, and register its link in the root README.md. Use this whenever the user wants to add, create, or write a new Tip in this repo — e.g. "nlp_processing に〜の Tip を追加して", "新しい Tips を作って", "〜の解説 Tip を書いて", "this repo に〜のネタを追加". It picks the right category and next sequential number, matches the README format of nearby Tips, generates code scaffolding (Dockerfile / requirements.txt / *_cpu.sh / *_gpu.sh / *.py) only when the Tip needs runnable code, and inserts the link into the correct <details> section of the root README. Trigger this even if the user doesn't say the word "skill" — any request to add a new entry to this Tips collection should use it.
リポジトリの構造・技術スタック・機能一覧・セットアップ手順を動的に解析し、 包括的なドキュメントを自動生成するスキル。言語・フレームワーク問わず汎用的に動作する。 Use this skill whenever the user asks to: - Explain a repository / リポジトリの説明 / リポジトリの概要 - Generate a README / README生成 / README作成 - Understand project structure / プロジェクト構成を教えて / 構造を説明して - Learn how to run a project / 使い方を教えて / 動かし方 / セットアップ方法 - Get a repo overview / repo overview / explain this repo / what does this repo do - List features / 機能一覧 / このプロジェクトは何ができる？ - Onboard to a new codebase / コードベースのキャッチアップ / 新しいリポジトリに入った - "このリポジトリ何？" "プロジェクトの全体像" "how to run this project" - "コードの全体を把握したい" "ドキュメントを整備して" "技術スタックを知りたい" This skill is especially useful when joining a new project, onboarding team members, or when a repository lacks proper documentation. It works with ANY repository regardless of programming language, framework, or project type.
Use when auditing repository documentation for drift, stale statements, broken references, or README mismatches, especially across published docs under `doc/` and key entry surfaces such as `README.md` (English default), `README.zh-CN.md`, `mcp/README.md`, and `mcp/README.zh-CN.md` during periodic maintenance or before preparing corrective PRs.
日本語の概要は準備中です。原文の説明を表示しています。
Use when creating or rewriting README.md for projects. Triggers on "write README", "create README", "update README". Creates human-focused documentation with proper structure.
日本語の概要は準備中です。原文の説明を表示しています。
Redesign GitHub README homepages or create project-native pure SVG, hybrid SVG-composed PNG/WebP, and opt-in animated GIF assets. Use when a user asks to beautify, redesign, rebrand, visually upgrade, simplify, or audit a GitHub README; create only a hero, section headers, diagrams, badges, motion graphics, showcase modules, or other README assets; or turn a repository homepage into a cohesive visual story. If whole-README work versus asset-only work is unclear, ask which scope the user wants. For hero-like assets where pure SVG and generated raster material are both viable, explain the tradeoffs and confirm the implementation before creating the asset.
日本語の概要は準備中です。原文の説明を表示しています。
Refreshes README structure favoring concision (an index, not a manual). Use when the README needs a structural update after significant project changes.
日本語の概要は準備中です。原文の説明を表示しています。
Generate comprehensive, user-friendly README.md files for code repositories. Use when creating documentation for new projects, updating existing READMEs, or improving project onboarding. Produces READMEs with project introduction, prerequisites, environment setup, executable usage instructions, and repository structure overview. Supports application projects, libraries, and research codebases.
日本語の概要は準備中です。原文の説明を表示しています。
生成一份对外可分享、脱敏的 AI-Native 开发者 README。 量化展示我对 Claude Code + Codex CLI + Kiro (AWS) + Trae (ByteDance) + Gemini Antigravity (Google) + Cursor 的使用深度、AI 协作风格、 项目与领域分布、兴趣主题，以及与 GitHub 提交的产出关联。 Trigger when the user says: "生成我的 AI 档案" / "做一份 AI-native README" / "分析我的 Claude / Codex / Kiro / Trae / Antigravity / Cursor 使用情况" / "总结我的 AI 使用" / "生成 AI 月度报告" / "按月份分析我的 AI 编码" / "分析 2026-05 的 AI 使用" / "build my AI usage profile" / "build my monthly AI coding report" / "analyze my AI usage for May 2026" / "summarize my Claude / Codex / Kiro / Trae / Antigravity / Cursor history" / "生成开发者画像". 全程本地、只读、默认匿名、不上传任何数据。
日本語の概要は準備中です。原文の説明を表示しています。
Generate ASCII-art text banners for terminals, READMEs, and CLI startup messages. Use when a user asks for an ASCII banner, text art, バナー, アスキーアート, or a decorative header for a script/README.
Mirror README.md and README.ko.md 1:1
日本語の概要は準備中です。原文の説明を表示しています。