SuperAPI AI 工具集

nk-documentation-best-practices

写作与研究

查看项目

更新于 10-16 09:33

技能介绍

用途:在 Naykel 各项目创建或更新文档时套用统一的共享规则;该技能会主动适用,不必等待明确请求。项目专属技能在其之上扩展,两者同时适用,冲突时项目技能优先。

主要能力与评审流程:每个新标题先标记 (review),内容确认后再去掉;更新带 (review) 的章节时,询问该章节是否完成;确认后移除 (review) 并更新项目状态文件。文档结构商定后即可从导航项移除 (wip),即使部分章节仍带 (review)。未解决的标题保留 (review)。当一个文档中所有 (review) 标记消失,视为完成。结束文档工作时,需指出仍带 (review) 标记的标题或文档。

通用规则:一篇文档只做一件事;若一个页面同时讲解心智模型、罗列全部属性并给出快速上手,应拆分。代码优先,仅在行为不直观或需要上下文时补充说明文字。

文档结构:每篇文档以标题和简短导语开头,导语写成 <p class="lead">...</p>,说明页面涵盖内容与读者能获得什么,保持具体、无填充内容;不另设 ## Introduction 章节。

导航管理:开始处理尚未收录到导航的文档时,将其加入真实分类,名称后缀 (wip) 以便开发期间访问。保持导航标签与分区最小化,仅在文档经过评审并达成一致后再补回结构。

规则文件:回复前阅读相关规则文件,不要只依赖摘要。组件文档对应 rules/component-docs.md,涵盖单组件页面、多组件页面、变体与组件族。

限制:公开资料未提供该技能的具体安装命令、支持的平台、收费与价格信息,暂未提供。