用途:该技能用于审阅整个项目与工作区,然后为项目创建一份全面且结构良好的 README.md 文件。
主要能力:以资深开源项目软件工程师的角色撰写文档,强调 README 具有吸引力、信息充分且易读;参考若干公开 README 示例的结构、语气与内容;使用 GFM(GitHub Flavored Markdown)格式化,并在合适处使用 GitHub admonition 语法;若发现项目 logo 或图标,会用于 README 头部。
使用方式:作为技能调用,对当前项目与工作区进行整体审阅后生成 README.md。资料未提供具体安装命令或调用参数。
限制与约定:不要过度使用 emoji,保持简洁切题;不包含 LICENSE、CONTRIBUTING、CHANGELOG 等章节,因为这些有专门文件承载。
适用场景:需要为开源或内部项目补齐或重写 README 时使用。
参考示例链接:https://raw.githubusercontent.com/Azure-Samples/serverless-chat-langchainjs/refs/heads/main/README.md、https://raw.githubusercontent.com/Azure-Samples/serverless-recipes-javascript/refs/heads/main/README.md、https://raw.githubusercontent.com/sinedied/run-on-output/refs/heads/main/README.md、https://raw.githubusercontent.com/sinedied/smoke/refs/heads/main/README.md。
其他信息(如收费、平台支持、具体安装步骤)暂未提供。