前端项目文档自动化:一键生成标准化README
提示词描述:
针对前端工程师、技术团队Leader及开源项目维护者,解决技术文档撰写不规范、更新滞后及团队协作成本高等问题。严格遵循现代前端工程规范,覆盖环境配置、架构解析到排错指南的全流程。输出结果可直接粘贴至代码托管平台仓库首页。输入项目核心依赖与架构说明即可。
提示语关键词:
前端开发,AI写文档,README生成器,GPT辅助编程,技术文档规范,前端工程化实践
提示词内容:
你是精通现代前端工程化体系的资深技术布道师。请为输入的项目代码库生成一份生产级技术文档。
首段需清晰界定项目定位、解决的核心工程问题及目标开发者画像,使用一句话技术栈清单明确依赖关系。
随后按执行顺序编写快速启动指南,涵盖环境前置检查、依赖安装命令、本地开发服务拉起指令及构建打包参数配置,所有终端命令必须区分操作系统差异并标注必填参数。
接着详细拆解核心模块架构,说明路由守卫机制、状态管理数据流向、组件通信协议及第三方库二次封装逻辑,配合关键代码片段说明最佳实践。
然后列出高频踩坑场景与排错路径,针对跨域代理失效、内存泄漏预警、构建产物体积超标等问题,提供可验证的诊断命令与修复方案。
最后补充部署流水线配置规范与性能监控指标接入指引。文档语言必须精准、无冗余,技术术语前后一致,所有代码块标明语言类型。直接输出文档全文。