用途:readme-craft 提供生产级 README.md 的写作模式,适用于任何项目类型,在创建项目文档、撰写 README 或改进现有文档时使用。它强调先讲价值主张而非安装步骤,描述工具解决的问题而非它是什么。
主要能力:给出“黄金结构”分层模板——第一层 Hero 区(居中 logo、徽章、一句话说明解决的问题、快速安装命令);第二层 TL;DR(问题、解决方案、功能与收益对照表);第三层 Quick Start(5-10 条命令演示核心工作流);第四层参考区(设计理念、替代方案对比、多种安装方式、命令参考、配置项、架构);第五层支持区(故障排查、限制、FAQ、贡献、许可证)。另提供对比表、多方式安装(curl 脚本、brew/apt/dnf/winget、源码编译)、命令参考、故障排查、限制表、FAQ 折叠块等章节模板,以及发布前检查清单和反模式对照表。
使用方式:按模板填充项目内容;徽章模板见 references/badge-reference.md;通用技术写作模式可参考 technical-writer 技能。示例命令如 curl -sSL https://example.com/install.sh | bash、mytool init、mytool process input.txt --output result.json、mytool status 等保持原样。
适用场景:开源项目、CLI 工具、库与复杂系统的 README 撰写与优化。
限制:资料未提供该技能的具体安装方式、收费情况、支持平台或实际效果数据;文中示例命令与 URL 均为模板占位内容,需替换为真实项目信息。