README 生成

生成或更新项目 README 的 skill。适用于撰写中文、英文或中英双语 README,翻译 README,统一项目文档结构,并保持安装、使用、配置、示例和贡献说明同步。

makerv1.0.0开发工具

readmedocumentationbilingual
已审核
下载 ZIP

README

README 生成

Overview

用于为项目创建、更新或翻译结构清晰的 README 文档。

When To Use

  • 用户要求写 README 或更新项目说明
  • 需要中英双语项目文档
  • 需要同步安装、使用、配置和示例说明

Inputs

  • 项目源码、已有 README、目标读者和语言偏好
  • 安装方式、使用示例、配置项和贡献规则

Outputs

  • README.md 或中英双语 README 内容
  • 文档结构建议和缺失信息清单

Included Files

  • `SKILL.md`: 核心工作流与使用说明
  • `_meta.json`: LeapSkills 发布元数据
  • `README.md`: 中文概览与使用说明
  • `test-prompts.json`: 测试触发样例

Notes

  • frontmatter 中的 `name` 保留英文 slug,便于 skill 系统稳定识别;中文名称记录在本文档和 `_meta.json` 中。
  • 使用前先确认用户目标、输入文件和期望输出格式。
安装说明

安装后请阅读 README.md,并按 SKILL.md 中的触发条件和工作流使用。

版本记录
v1.0.0

已发布

- 首次上传标准化中文版本

包信息
安装命令leapskills install readme-gen
文件大小819.9 KB
SHA-2569acbff4bbe747830d93b44891cafa971e9b4a36d572ea22da8316cf93bec9fe7
最近审核2026/05/07 15:04
风险等级低风险