SuperAPI AI 工具集

diataxis-gen-readme

通用与其它

查看项目

更新于 10-16 02:33

技能介绍

用途:该技能用于生成产品文档的 README 开头部分,采用 Diataxis 四段式结构,将模板中的占位文本替换为针对具体产品的内容。

主要能力与结构: 第一段为一句话,简洁、易记地说明产品是什么。 第二段为一到三句短句,描述产品做什么。 第三段长度相近,解释产品满足什么需求。 第四段描述产品对谁有用。

使用方式:按给定的四段结构撰写,每一段以加粗的引导句开头,然后将占位文字替换为与产品相关的内容。

检查项:需确保模板中的四个加粗引导句均存在,且只有占位文本被替换为产品特定内容。

限制:资料未提供该技能的具体安装命令、运行环境、平台支持、收费方式或详细操作步骤,这些信息暂未提供。模板正文中的拉丁文占位内容不应作为实际产品描述使用。