SuperAPI AI 工具集

write-internal-docs

前端与建站

查看项目

更新于 10-15 20:08

技能介绍

用途:在私有仓库 browseros-ai/internal-docs 中撰写内部文档,输出 Markdown 及自包含 HTML 同源文件,并提交 PR。主题可由用户指定(如 /write-internal-docs nightly signing),或在功能分支无主题时取分支 diff。它是 ask-internal 的姊妹技能:后者读内部文档,此技能写。

主要流程;先做预检,确认 .internal-docs 子模块已初始化、gh 已认证、SSH 能访问 internal-docs;否则停止并给出修复命令。随后确定四项事实:主题、类型与目标目录(setup/、features/、architecture/、designs/)、文件名(kebab-case,features 前缀 YYYY-MM-,designs 前缀 YYYY-MM-DD-)与负责人。撰写前先做一层抽象,画出覆盖模块、调用方与数据流的简图,作为正文首节。再按 .internal-docs/_templates/ 中匹配模板起草 Markdown,每个事实引用实际读过的 path/to/file.ts:line,空模板节保持为空。通过文风检查后,克隆仓库写入 .md,并由它渲染 .html 兄弟文件,HTML 保持自包含。随后做 tidy 扫描,检查死链、未索引文档与放错位置的文档,解释规则后修正,并单独提交 chore(docs): tidy structure and index。最后在 README 索引中加入新文档行,提交文档并创建 PR。

限制:绝不在用户的 .internal-docs/ 检出中写入,只在工作克隆中写;绝不推送到 main,只走功能分支加 PR;绝不触碰 OSS 仓库的 .gitmodules 或子模块指针;绝不 git add -A 或 git add .;不带目录存在守卫就不运行克隆相关命令;不为空模板节编造内容;不手改 .html 兄弟文件;不引用未实际读过的文件或行号。文风要求:首句给要点、具体名词、短句、主动语态、禁用词表,feature 正文最多 60 行。