SuperAPI AI 工具集

documentation-templates

写作与研究

查看项目

更新于 10-15 21:11

技能介绍

用途:为常见文档类型提供模板与结构规范,帮助开发者统一项目文档的写法与组织方式。

主要能力:资料列出 README 结构、README 模板、按端点(per-endpoint)的 API 文档模板、JSDoc/TSDoc 注释模板、何时添加注释的指引,以及变更日志条目(Added、Changed、Fixed)和 llms.txt 模板,并提及 MCP-Ready 文档。

使用方式:按资料中的模板与优先级顺序套用到自己的项目中;README 部分给出必要章节的优先顺序,API 文档按端点逐个套用模板,代码注释使用 JSDoc/TSDoc 模板,变更日志按 Added、Changed、Fixed 分类记录。具体命令、安装方式与代码示例资料未提供。

适用场景:编写或整理项目 README、API 文档、代码注释、变更日志,以及为 LLM 或 MCP 场景准备文档时参考。

限制:资料仅给出模板与结构要点,未提供完整示例、工具集成方式、平台支持或收费信息,这些内容暂未提供。