Results for “readme”

🇺🇸 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レビュー"

The English summary is being prepared. Showing the original description.

GitHub OSS向け README.md の作成・改善・レビューを支援する。What/Why/How to start/Help/Maintainers の軸で情報を整理し、最短で動かせる Quickstart と docs への導線を構成する。 READMEの新規作成、既存READMEの再構成、READMEレビュー、ドキュメント分割の判断時に使用する。 トリガー：「READMEを作って」「READMEを改善して」「Quickstartを追加して」 「GitHub向けREADMEテンプレ」「READMEをレビューして」などのREADME関連リクエスト。

The English summary is being prepared. Showing the original description.

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.

The English summary is being prepared. Showing the original description.

Create a clear, concise README.md after reviewing the project and workspace. Uses example READMEs to guide structure and tone, formats the result for GitHub, and includes an existing project logo or icon when available.

• Write a README for a project that lacks one
• Introduce a project to new readers
• Organize a README using existing examples

Create an SVG usage card from local Claude Code, Codex, Gemini CLI, and OpenCode logs. It summarizes token counts, equivalent API cost, consecutive activity days, and each agent's share for inclusion in a README or documentation.

• Displaying coding-agent usage in a README
• Sharing an activity summary across multiple agents
• Showing token counts and equivalent API cost

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.

The English summary is being prepared. Showing the original description.

Create pixel art illustrations as SVG files, a scalable image format, for READMEs, documentation, and slides. Build character portraits, conversations, or group scenes, then refine colors, speech bubbles, arrows, and spacing to fit the requested layout.

• Create a pixel art hero image for a README
• Illustrate a conversation with characters and speech bubbles
• Make a character illustration in project colors

Write and edit READMEs, guides, and other documentation using the code as evidence. Improve structure, wording, and terminology while checking related pages and links against the project's contribution process and documentation style guide.

• Writing a guide for an existing feature
• Improving a README's structure and wording
• Updating documentation to match the implementation

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.

The English summary is being prepared. Showing the original description.

Turn source code into project documentation, from a README with installation steps and examples to API references, architecture diagrams, developer guides, and changelogs. Match the scope and comment format to the project's size and programming language.

• Creating a README with installation steps and usage examples
• Documenting public functions, parameters, and return values
• Preparing architecture and contributor guides for new developers

Create or revise Markdown files for notes, README files, meeting minutes, and documentation. Organize content with headings, lists, and suitable tables, then read the finished file to check formatting and remove unfinished content.

• Create a project README
• Turn meeting notes into minutes
• Revise a Markdown manual

Write or update repository and product documentation, including README files, user guides, API documentation, architecture notes, and migration instructions. Identify the audience, improve existing documents where possible, and verify commands and paths while flagging unknown details.

• Updating a README or user guide
• Writing API or architecture documentation
• Preparing migration instructions

Review documentation, READMEs, guides, or prose against the good-docs-writing style rules. Receive structured findings with file and line references, quoted passages, and concrete rewrites. Files are edited only when explicitly requested.

• Checking a README's voice and tone
• Auditing a guide against writing rules
• Getting specific rewrites for flagged passages

Write and maintain technical documents for different readers, including READMEs, API references, operational procedures, architecture explanations, and onboarding guides. Organize practical examples, setup steps, design decisions, and recovery instructions around what each audience needs.

• Create a README with a quick start
• Document API requests and responses
• Write operational and rollback procedures

Create and organize API documentation, READMEs, onboarding guides, and architecture decision records that explain design choices. Structure content around readers’ tasks, with consistent terminology, complete code examples, and separate sections for instructions, reference details, and explanations.

• Writing a README with installation and quick-start instructions
• Documenting API parameters, return values, and errors
• Recording architecture decisions and their consequences

Write and maintain technical documents for different readers, including READMEs, API references, operational procedures, architecture explanations, and onboarding guides. Organize practical examples, setup steps, design decisions, and recovery instructions around what each audience needs.

• Create a README with a quick start
• Document API requests and responses
• Write operational and rollback procedures

Generate README.md and DESIGN.md outlines by inspecting a module's files, language, and dependencies. Python analysis also extracts classes, functions, and docstrings, providing a starting point for usage documentation and design records that you complete afterward.

• Create documentation outlines for a new module
• Add missing README.md and DESIGN.md files
• Summarize Python classes and functions

Create and review technical documentation alongside repository instructions for agents and contributors. The skill checks clarity, working procedures, documentation coverage, and consistency across languages, then provides updated drafts or findings with validation notes.

• Creating or updating technical documentation
• Reviewing README files and documentation changes
• Aligning agent instructions with contribution procedures

Create static SVG diagrams, scalable images for lessons, READMEs, and manuals. It uses real system names, nine diagram types, and consistent colors and arrows, with checks for readable labels, accessible descriptions, and valid markup.

• Add a diagram of system interactions to a README
• Explain state transitions in a manual
• Illustrate data flow from logs or specifications

Prepare an existing Twenty app for npm or marketplace publication by reviewing its README, listing details, package metadata, logos, and screenshots. The workflow includes checking publication settings, validating the build, and running the publishing command.

• Prepare a Twenty app marketplace listing
• Write or review README and About text
• Check logos, screenshots, and public assets

Maintain Cherry Studio documentation by checking it against source code, placing facts in appropriate files, and removing duplication. Review documentation affected by code changes and keep relevant English and Chinese counterparts aligned.

• Organizing READMEs and reference documentation
• Reviewing documentation affected by code changes
• Checking comments and agent instructions against code

Create task-oriented READMEs, API references, architecture documentation, and security reports. Organize information from quick starts to deeper explanations, and turn completed investigations into formal Markdown reports with supporting evidence, reproducible steps, and appropriately masked sensitive information.

• Writing a README with a clear quick start
• Organizing API and architecture documentation
• Reporting reverse engineering or penetration test findings

Write and revise Chinese technical documentation using consistent spacing, punctuation, terminology, and structure. Includes README.md and API documentation templates, bilingual formatting examples, and a checklist for reviewing documents before publication.

• Standardizing spacing and punctuation in Chinese documents
• Writing a Chinese README.md
• Organizing API documentation in Chinese and English

Structure guides, READMEs, design documents, and pull request descriptions so readers can find answers quickly. Put outcomes first, introduce details gradually, and use examples, tables, and checklists to support understanding and review.

• Reorganizing a long or dense README
• Writing an onboarding guide for new contributors
• Making a pull request's review steps clear