SuperAPI AI 工具集

documentation-organization

写作与研究

查看项目

更新于 10-15 20:33

技能介绍

用途:该技能面向 Databricks 项目,解决文档存放位置与命名混乱问题,并支持为技术框架或系统编写成套文档。

主要能力:模式一为组织规范,创建 .md 文件前先检查位置,将部署、清单、问题、步骤、总结等文档路由到 docs/ 下对应目录,根目录仅允许 README.md、QUICKSTART.md、CHANGELOG.md、LICENSE;命名统一用 kebab-case,历史文档加 YYYY-MM-DD- 前缀,框架文档用 NN- 编号。根目录 .md 超过 3 个时主动建议清理,并保留 deployment-history/ 与 troubleshooting/ 中的历史记录。模式二为框架文档编写,先收集框架名称、受众、用途、技术栈、组件数量与文档深度,再在 docs/{framework-name}-design/ 下生成 00-index.md、01-introduction.md、架构、组件、实施、运维、排障及附录等模板文件,最后按质量清单校验。

使用方式:用户提出创建文档或编写框架文档时自动触发;框架模式需先完成需求收集,再加载模板生成。

适用场景:Databricks 项目文档整理、部署与排障记录归档、ML 框架、告警框架、语义层等系统的成套文档编写。

限制:资料未提供具体安装命令、收费方式与平台支持信息;模板与脚本细节需参考其 references 文件。