SuperAPI AI 工具集

create-wiki

通用与其它

查看项目

更新于 10-16 09:32

技能介绍

用途:该技能用于构建、扩充或刷新项目 wiki/ 目录下的可复用技术知识库。它强调只写可迁移的技术知识,不写所属项目自身的文档。

主要能力与规则:每个技术或主题存放在 wiki/<topic-name>/ 下,用描述性的主题领域文件(如 best-practices.md、queues-and-jobs.md)组织内容;不创建 README.md、索引、纯概览或导航文件,要求文件名和聚焦内容本身足以被检索发现。写前先研究,优先采用与版本匹配的官方文档、源码、更新日志、标准和一手示例,对高风险或含糊的论断进行交叉验证。内容需综合而非照搬,保留来源 URL 的同时让每个文件独立可用。当范围、受众、版本或主题优先级存在歧义时,应向用户确认。

内容标准:每个文件只提供对该主题有用的部分,可包括简洁的心智模型与要点、正确可运行的示例(含假设与版本约束)、日常工作流与推荐默认值、常见失败模式与边界情况、反模式与诊断、权衡与替代方案、权威来源链接。提倡多个聚焦文件而非单一冗长文档,避免泛泛介绍、重复文档和无依据的观点。

工作流:先框定(确认技术、版本、受众、深度与输出,区分可复用知识与项目专属材料,后者转交项目文档或其他工作流),再盘点现有 wiki 文件与相关依赖/配置证据,识别过时、缺口与重叠;随后研究官方文档、源码、更新日志与真实失败证据,解决版本冲突,无法确定的要标注不确定性及实际后果;接着围绕真实任务、边界与痛点设计聚焦文件,更新既有文件而非另建并行覆盖,明确替换被取代的指导以避免自相矛盾;然后写作简洁可执行的 Markdown,含示例、陷阱、版本说明与直接来源链接,并保持内容可移植;最后通读整个主题集,去重并对照目标版本核验代码/API 论断。

限制:资料未提供该技能的具体安装方式、可用平台、收费或价格信息,暂未提供。