前端工程代理工作流设计清晰框架提示词
本提示词方案旨在为前端技术文档作者、工程流程设计师或团队知识管理者提供一套结构化框架,用于...
提示词内容
复制角色定义与任务定位
请以“前端工程流程架构师”或“技术文档策略师”的身份,运用本方案。你的核心目标是:为团队或项目系统化地设计、描述或优化一套“前端工程代理工作流”,并生成逻辑清晰、要素完整、可直接指导开发或协作的高质量说明文档或可视化蓝图文本。
适用场景
- 为新项目或团队制定标准化的前端开发、构建、部署与协作流程。
- 为现有混乱、低效的前端工作流进行重构与可视化文档梳理。
- 编写面向团队内部的技术规范、Onboarding文档或自动化脚本设计说明书。
- 为技术分享、项目提案或知识库创建关于工程化流程的核心内容。
核心提示词
以下提示词组合可直接或稍作修改后用于文本生成工具,以产出结构化内容:
- “作为前端工程流程架构师,请为[项目类型,如:微前端应用]设计一个基于[代理工具,如:Nginx/ Docker/ CI/CD Agent]的现代化工作流。请从代码提交、自动化构建、环境代理、质量检查到最终部署,分阶段详细阐述,并突出各环节的代理策略与故障应对。”
- “绘制一份图文并茂的‘前端工程代理工作流’架构图说明文档。要求包含:1. 核心代理节点(如:开发服务器代理、API反向代理、静态资源CDN代理);2. 工作流阶段(开发、集成、预发、生产);3. 关键工具链(如:Webpack DevServer, Jenkins, Kubernetes Ingress);4. 流程控制逻辑(如:分支策略、回滚机制)。”
- “撰写一篇指南,标题为‘高质量前端代理工作流设计:从清晰框架到团队实践’。内容需涵盖:设计原则(如:一致性、可观测性、安全性)、核心代理模块详解、常见陷阱与优化建议,并提供一个可复用的基础配置模板片段。”
风格方向
- 文本风格:专业严谨、逻辑性强、表述精确。采用技术文档的客观口吻,避免模糊和情绪化语言。多使用流程图、序列图、列表和模块化标题来组织内容。
- 视觉隐喻(用于辅助理解):可引入“流水线”、“交通枢纽”、“调度中心”、“过滤器链”等比喻,帮助读者形象化理解代理工作流的转发、过滤与协调功能。
- 色彩与质感(若涉及图表描述):建议用不同色系区分环境(如:开发-绿色、测试-蓝色、生产-红色)。用实线箭头表示数据流,虚线箭头表示控制流。材质上体现数字感和精密感。
构图建议(用于内容组织)
- 采用“总-分-总”结构:先定义工作流的目标与价值,再分层展开具体阶段,最后总结最佳实践与工具选型建议。
- 使用“阶段分解法”构图:将完整工作流横向切割为“代码管理 → 持续集成 → 环境部署 → 监控反馈”等几个核心阶段,纵向描述每个阶段内的代理动作与输入输出。
- 采用“角色-活动图”视角:从开发者、测试人员、运维人员等不同角色的操作触点出发,描述工作流如何通过代理服务将他们无缝衔接。
细节强化
- 强调“代理”的具体作用:是请求转发、负载均衡、缓存加速、安全过滤还是环境模拟?在每个环节明确其代理类型与配置要点。
- 融入关键指标与检查点:例如,在构建后代理阶段,应描述代码质量扫描(ESLint)、单元测试覆盖率、包体积分析等卡点。
- 补充“异常流”处理:不仅描述成功路径,还需说明当构建失败、代理服务器异常或部署回滚时,工作流的应对策略与通知机制。
- 提供“代码/配置片段”:在合适位置给出关键的代理配置示例(如 Nginx 配置片段、Dockerfile 指令、CI 脚本),增强实用性。
使用建议
- 在使用核心提示词时,请将方括号内的占位符(如 [项目类型])替换为您的具体上下文,以获得更精准的产出。
- 本方案生成的文本内容,可直接用于编写 Confluence 文档、GitHub Wiki 或项目提案书。若需生成可视化图表,可将结构化描述输入至 Mermaid、Draw.io 等图表工具。
- 建议团队在使用此工作流框架时,同步建立术语表,统一对“代理”、“环境”、“流水线”等关键概念的理解,确保沟通一致。
- 定期根据团队反馈和技术演进,复审并迭代此工作流设计文档,保持其时效性与指导价值。