SuperAPI AI 工具集

writing-plugin-readme

写作与研究

查看项目

更新于 10-16 04:12

技能介绍

用途

该技能是一个关于「如何撰写插件 README」的写作指南,适用于为某个仓库中的插件、工具及其子资源编写或更新清晰、可读、专业的 README 文档。其描述明确指出,它服务于「本插件或其单独工具与资源」的说明文档编写。

适用时机

根据资料,以下情形适合使用该技能:

  • 需要为该插件编写或更新主仓库的 README.md。
  • 正在为新的脚本、工具或参考目录编写文档。
  • 希望确保 README 具备一致的结构、可直接复制粘贴的命令,以及清晰的安装指引。

必备 README 清单

资料给出的专业 README 必需章节包括:

  • 标题/Header:清晰的标题,以及 1–2 句话的插件/工具功能高层摘要。
  • 功能(Features):以项目符号列出主要功能或能力。
  • 先决条件与安装(Prerequisites & Installation):明确依赖(例如 Python 包、yt-dlp、SQLite3)以及用于安装的命令行指令。
  • 使用指南(Usage Guide):真实的 CLI 示例,含预期输入/输出。
  • 目录/架构图(Directory / Architecture Map):以可视化图表或列表映射关键文件与目录。
  • 贡献与许可(Contributing & License):基本贡献规则与许可条款。

核心模板

资料提供了一个「主插件 README 模板」,结构如下:

  • 以 # Plugin Name 作为一级标题,随后用 1–2 句话说明插件用途及面向的用户。
  • ## Features 下以加粗项目符号列出功能,如 **Feature A**: ...、**Feature B**: ...。
  • ## Prerequisites & Installation 下列出系统需安装的内容,示例中包括 Python 3.10+ 与 yt-dlp(用于媒体下载),并给出通过 Skills CLI 安装技能的 bash 代码块,例如:
    • npx skills add zenithth/anibon-stream-synthesis --all -g(全局安装全部技能)
    • npx skills add zenithth/anibon-stream-synthesis --skill anibon-timestamper -g -y(安装指定技能)
  • 「Quick Start & Usage」部分给出可复制粘贴的示例命令,如 python3 scripts/run_tool.py --argument value。
  • 「Options」部分列出命令行选项,示例包括 --verbose(启用详细日志)与 --limit(最大处理条目数)。
  • 「File Structure」部分说明目录用途,示例包括 scripts/(Python 工具脚本)、skills/(嵌套的 agent 子技能)、tests/(自动化单元与集成测试)。
  • 「License」部分说明按 MIT 许可分发,详见 LICENSE。

格式化规则

资料规定的格式化要求包括:

  • 使用代码块:命令、选项和代码片段始终放入带语言标签的围栏代码块中(如 bash、python、json)。
  • 策略性使用提示框:使用 GitHub 提示框(> [!NOTE]、> [!IMPORTANT]、> [!WARNING])突出环境要求或许可约束。
  • 清单格式:对安装任务清单或配置,使用标准 Markdown 复选框(- [ ])。

常见错误

资料列出的常见问题包括:

  • 命令含糊:只写 python run.py 而不指明相对路径或必需参数;应始终写出确切路径,例如 python3 scripts/run_tool.py。
  • 遗漏先决条件:忘记说明非 Python 标准库的外部 CLI 工具(如 ffmpeg 或 yt-dlp)。
  • 占位文本:留下未完成章节或类似 <insert details here> 的占位括号文本;应补全或删除。

限制

资料未提供该技能的付费方式、价格、适用平台等细节,这些内容暂未提供。