进阶版前端工程文档自动化处理提示词

角色定义与任务定位
请以“前端工程文档架构师”的身份，运用本方案。您的核心目标是：设计并实施一套自动化、结构化的文档处理流程，将零散、重复的前端文档工作（如组件说明、API文档、项目规范）转化为高效、统一、可维护的知识体系，从而提升团队开发效率与项目质量。

适用场景

为大型前端项目或组件库批量生成标准化的API文档。
自动化同步代码注释与对外技术文档，确保信息一致性。
将杂乱的项目README、开发规范重构为结构清晰的文档站点。
为CI/CD流程集成文档质量检查与自动发布任务。
建立团队内部技术方案评审与知识沉淀的标准化模板。


核心提示词
以下提示词可直接组合或拆分使用，作为自动化脚本或AI工具的输入指令：

“解析 `src/components/Button/` 目录下的所有 `.tsx` 文件，提取JSDoc/TsDoc注释，按照‘属性说明’、‘方法’、‘事件’、‘示例代码’四个模块，生成Markdown格式的组件文档。”
“对比本次Git提交的代码变更，自动更新对应的API文档段落，并在Pull Request中生成文档变更摘要。”
“扫描项目根目录的 `package.json`、`config` 文件及主要源码结构，自动生成一份包含‘项目概述’、‘环境配置’、‘脚本命令’、‘目录说明’的标准化项目初始化文档。”
“使用工具 [指定工具名，如：Swagger/OpenAPI] 解析后端接口定义，自动生成前端服务层的TypeScript类型声明和接口调用函数文档。”
“检查所有Markdown文档的标题层级、内部链接有效性和代码块语言标注，输出格式规范检查报告并自动修复常见问题。”


风格方向

技术极简主义：文档结构清晰，信息密度高，避免冗余描述。采用一致的术语体系。
开发者友好：以代码思维组织内容，优先展示接口定义、示例和常见问题，理论阐述后置。
自动化友好：文档源文件（如Markdown）本身具有良好的结构，便于工具解析和提取关键信息。
视觉结构化：合理运用表格、流程图、序列图、代码高亮块，使复杂逻辑一目了然。


构图建议（信息架构）

分层结构：采用“项目总览 -> 模块指南 -> 组件/API详情”的三层信息架构。
统一导航：每个文档页面保持一致的侧边栏导航和面包屑路径，确保定位清晰。
模块化布局：每个功能单元独立成节，包含“功能简述”、“代码示例”、“参数说明”、“注意事项”固定区块。
前后关联：在文档中智能插入相关组件或API的跳转链接，形成知识网络。


细节强化

元数据自动化：为每篇文档自动生成“最后更新时间”、“关联版本号”、“负责人”等元数据。
版本对比：在API文档中提供不同版本间参数或行为的差异化对比视图。
交互式增强：集成可运行的代码沙盒示例、可折叠的长内容区块、类型提示的悬浮查看。
质量门禁：设置自动化检查点，如“未编写文档的新组件禁止合并”、“文档可读性分数阈值”。
术语统一：建立项目术语表，并在文档生成过程中自动链接和提示关键术语。


使用建议

分阶段实施：优先为核心公共组件和复杂模块实施自动化文档，再逐步推广至全项目。
工具链集成：将文档生成与校验命令集成到 `npm scripts` 或 `Husky` 的 `pre-commit` 钩子中，形成开发习惯。
活文档文化：将文档更新作为代码审查的必要环节，确保自动化生成的内容经过人工校验与优化。
定期审计：每季度运行一次全量文档的链接、示例、与代码一致性审计，并生成维护任务。
组合使用：将“核心提示词”中的多条指令串联，可以构建从代码分析到文档发布的全流水线。