SuperAPI AI 工具集

create-doc

写作与研究

查看项目

更新于 10-16 06:20

技能介绍

用途:当用户要求创建、撰写或添加文档时,在 .chalk/docs/ 下新建一个文档文件。

工作流程:解析请求,从 $ARGUMENTS 识别目标垂直领域与主题;检查目标目录中已有文件名,找出最大编号,新文档编号为最大编号加一;撰写有实质内容的文档而非占位草稿;保存到 .chalk/docs/<vertical>/<number>_<slug>.md;最后告知用户文档路径与简要摘要。

垂直领域与目录:product/ 用于愿景、战略、用户研究、定价、竞争分析;ai/ 用于智能体上下文、代码库导览、提示模式、注意事项;engineering/ 用于架构、约定、API、运行手册、数据流;根目录 .chalk/docs/ 用于不属于以上分类的文档。用户指定垂直领域时按其指定,含糊时根据内容推断。

命名约定:<number><snake_case_slug>.md,编号在垂直目录内顺序递增(profile 文档固定为 0),slug 为简短的 snake_case 摘要。

文档结构:首个 # 标题为文档名,紧随其后是 Last updated: <YYYY-MM-DD>(含简短变更说明),各节使用 ## 标题,不使用 YAML frontmatter,支持全部 GFM 特性(表格、复选框、删除线、代码块、Mermaid 图)。

内容基调:product/ 面向业务、简洁,聚焦是什么与为什么;ai/ 面向智能体、参考风格,聚焦位置、运作方式与注意事项;engineering/ 技术性、全面,聚焦架构、约定、API 与数据流。

限制:资料未提供安装命令、收费或平台信息。