AI代码规范文档

什么是AI代码规范文档？

如何使用AI代码规范文档

1. 1

   填写基础信息：在对应输入框中填写团队使用的具体技术栈名称，同时补充团队当前的规模大小、日常协作模式与团队现有的编码习惯偏好，确保信息清晰明确。

2. 2

   触发 AI 生成：检查填写的所有基础信息无误后，点击页面下方的『生成规范文档』按钮，稍作等待即可获取 AI 生成的完整内容。

3. 3

   调整细节内容：浏览生成的内容，找到不符合团队现有协作习惯或者要求的规则，直接在当前页面的编辑框内修改调整细节。

4. 4

   导出规范文档：所有细节调整确认完成后，全选生成并修改好的内容复制出来，粘贴到团队内部共享的文档库中归档使用。

什么场景会用到？

计算示例

注意事项

• 生成的规范是通用基础版本，需根据团队已有技术习惯调整，不要直接强制替换团队已有沉淀规则。
• 工具会根据技术栈自动匹配行业常见约定，如果团队有特殊框架或自研工具，需要手动补充对应规则。
• 生成内容基于通用大模型训练数据，不包含特定公司内部的私有编码要求，需手动补充涉密、权限相关约束。
• 如果输入的技术栈比较小众，生成内容可能偏泛化，需要针对小众技术点补充细节规则。

常见问题

参考资料

• Google 开源项目风格指南（行业通用代码规范参考）
• MDN Web Docs 前端编码实践相关文档

本工具生成内容基于行业通用代码规范框架整理，所有示例输出均经过工具实际生成验证，由工具集编辑组定期更新大模型提示词适配最新技术生态。