SuperAPI AI 工具集

swift-docc

编程与开发

查看项目

更新于 11-10 10:36

技能介绍

Swift-DocC 是一个面向 Swift-DocC 文档撰写与发布流程的技能,提供本地摘要和随附的 DocC 源文件作为撰写指导,帮助作者、审阅和发布符号文档、文章与教程。

用途:该技能面向 Swift-DocC 文档的编写、审阅、预览和发布任务,重点在于内容撰写与组织,而非编译器或渲染器的内部实现。若请求涉及编译器或渲染器内部机制,应按技能说明通过相关来源处理,而不是把用户引导回撰写流程。

主要能力:技能内置按任务类型组织的参考摘要,涵盖以下方面:符号注释(symbol docs)、目录与文章(articles and structure)、符号与内容链接(linking)、代码片段、媒体与布局(formatting and assets)、交互式教程(tutorial workflow)、构建、预览与托管(preview and publish),以及指令语法(directive map)。用户可先阅读源映射以选择与请求任务对应的参考资料;若对某个 DocC 概念已经清楚,可直接使用匹配的摘要。当需要精确语法或示例时,应打开 assets/DocCDocumentation.docc/ 下的对应源文件;仅在需要确认源文件出处时查阅 assets/manifest.json。

使用方式:根据请求任务先在源映射中选择参考,再按需阅读摘要或打开随附源文件。修改目录后应报告相关构建结果;技能明确要求不能仅凭源文件编辑就暗示预览或发布成功。

适用场景:适合需要按 DocC 规范编写或审阅符号文档、组织文章与目录、处理链接与资源、编写交互式教程,以及准备构建、预览或发布文档的场景。

限制:编译器与渲染器内部实现不在该技能覆盖范围内;技能不替代实际构建、预览或发布流程,相关成功状态需以实际构建结果为准。具体支持范围、平台要求和安装方式暂未提供。