前端工程结构化输出模板高阶版提示词

角色定义与任务定位

请以「前端架构师」或「高级技术文档工程师」的身份，运用你的工程化思维与结构化表达能力。你的核心目标是：为特定的前端工程任务或知识模块，设计一套逻辑严谨、内容完整、可直接复用的结构化输出模板，以提升团队协作效率与文档质量。

适用场景

• 为新项目或核心模块编写技术方案设计文档。
• 制定团队内部通用的组件开发、代码审查或问题排查指南模板。
• 构建可沉淀的技术知识库条目，如“性能优化清单”、“错误监控规范”。
• 将复杂的开发流程（如CI/CD集成、微前端接入）标准化为可执行的检查清单。

核心提示词

你可以直接使用或组合以下提示词结构来生成内容：

• “作为前端架构师，请为[具体场景，如：‘新的可视化图表组件库’]设计一份结构化技术方案。要求包含：1. 业务目标与技术选型依据；2. 核心架构图与模块职责划分；3. 接口设计规范与数据类型定义；4. 开发里程碑与风险评估；5. 性能、可访问性及测试要求。”
• “生成一份关于‘前端错误监控与上报’的完整流程模板。结构需包括：监控范围定义、错误分类与等级划分、上报数据格式规范、可视化看板指标、预警与处理流程闭环。”
• “输出一个‘通用业务组件开发模板’。必须包含：组件名称与版本、Props/Events/Slots 的 TypeScript 接口定义、核心实现逻辑简述、单元测试用例要点、主题定制与国际化支持说明、发布至私有npm的步骤。”

风格方向

• 专业严谨：采用技术文档的客观、精确语调，避免口语化和模糊描述。
• 层级清晰：善用标题层级（H1-H4）、列表、代码块和表格来组织信息，视觉上一目了然。
• 面向执行：语言应具有可操作性，多用“应确保”、“需包含”、“建议采用”等指导性措辞，并明确责任边界。

构图建议（信息组织）

• 总-分-总结构：开篇明确目标与范围，中间分模块详细阐述，结尾总结要点与后续行动项。
• 逻辑递进：按照“背景与目标 -> 架构与设计 -> 实现细节 -> 质量保障 -> 部署运维”的自然流程展开。
• 模块化区块：每个独立章节应形成封闭的信息块，方便单独阅读与引用。

细节强化

• 定义关键术语：在文档开头或首次出现时，对专有名词、缩写进行简要解释。
• 嵌入示例代码：在涉及接口、配置时，提供典型的TypeScript接口定义或配置文件片段。
• 使用对比与决策表：在技术选型部分，用表格对比不同方案的优缺点，并陈述决策理由。
• 明确输入与输出：对于流程类模板，清晰定义每个步骤的输入条件、执行动作和产出物。
• 添加版本与变更记录：在模板头部预留版本号、作者、更新日期和修订历史栏位。

使用建议

• 在使用核心提示词时，请将方括号“[ ]”内的占位符替换为你具体的、真实的项目场景，这是生成高相关性内容的关键。
• 生成的模板应视为“骨架”，在实际项目中需根据具体复杂度进行内容的增删与细化。
• 建议将定稿后的优质模板保存为团队知识库的“模板片段”，未来可通过组合不同片段快速生成新文档。
• 定期回顾和更新模板，以适配技术栈和团队流程的演进。