结构化前端工程On-Prem私有化文档提示词

角色定义与任务定位

请以前端架构师兼技术文档负责人的身份，为团队或客户生成一份关于如何在私有化部署（On-Prem）环境中，构建、规范与管理结构化前端工程体系的权威性、指导性文档。你的核心目标是产出逻辑严密、步骤清晰、可直接指导开发与运维实践的技术方案，确保在隔离网络环境下前端工程的可靠性、可维护性与标准化。

适用场景

• 为企业内部私有化部署的前端项目编写工程化规范文档。
• 为新团队接入现有On-Prem前端工程体系编写上手指南。
• 为项目复盘或知识沉淀撰写架构设计与最佳实践总结。
• 为客户交付私有化产品时，附赠的工程环境配置与开发说明。

核心提示词

可直接用于文档生成或内容组织的核心指令组合：

• 撰写一份《On-Prem环境前端结构化工程指南》，涵盖从代码仓库搭建到生产部署的全链路。
• 详细说明在无外网或受限网络条件下，如何搭建私有NPM镜像、管理依赖版本与构建环境。
• 定义并解释适用于私有化项目的目录结构规范、代码提交约定（Commit Lint）与Git分支策略。
• 制定针对内网环境的CI/CD流水线方案，包括容器化构建、静态资源发布与版本回滚机制。
• 提供内网环境下的前端监控、日志收集与性能优化专项建议。

风格方向

• 文体风格：采用技术白皮书与标准操作手册相结合的风格，权威、精准、条理分明。
• 语言调性：专业严谨，避免口语化，但需兼顾可读性，对复杂概念提供简明解释。
• 视觉隐喻：在描述架构时，可使用“蓝图”、“基石”、“流水线”、“安全围栏”等比喻，增强理解。
• 色彩与氛围：内容传达应体现“清晰”、“可靠”、“有序”和“受控”的理性氛围，避免模糊或随意的表述。

构图建议（文档结构）

将文档想象为一个层次分明的系统架构图，建议按以下逻辑顺序组织内容：

• 顶层设计（远景）：文档概述、目标与核心原则。
• 基础层（地基）：环境准备（Docker/虚拟机）、私有仓库（Git/Nexus）、网络代理配置。
• 规范层（框架）：项目脚手架、目录结构、代码规范（ESLint/Prettier）、Git工作流。
• 工具链（流水线）：私有依赖安装、构建配置（Webpack/Vite）、质量检查、镜像构建。
• 部署与运维（交付）：内网发布流程、版本管理、监控告警集成、应急预案。
• 附录（工具箱）：常见问题排查、配置示例片段、内部工具使用指南。

细节强化

在生成具体章节时，聚焦以下细节以提升文档的实用性：

• 具体配置示例：提供`.npmrc`、`.gitlab-ci.yml`、`Dockerfile`等关键配置文件的片段示例。
• 版本对照：明确列出建议的Node.js、Webpack、框架版本及其在私有环境下的兼容性说明。
• 路径与地址：使用占位符如`http://internal-registry.company.com`，示意内网地址格式。
• 安全考量：强调依赖安全扫描（如利用SonarQube）、镜像漏洞检查、访问权限控制等。
• 故障场景：描述“构建失败”、“依赖下载超时”等典型问题的诊断步骤与解决方案。

使用建议

• 将“核心提示词”中的任意一条作为文档生成的起点，逐步展开。
• 在生成过程中，可随时回溯“角色定义”，确保内容始终服务于架构师的技术决策与团队指导职责。
• 利用“构图建议”作为文档大纲，再使用“细节强化”中的要点填充每个章节的血肉。
• 最终产出应为可直接嵌入Confluence、Wiki或作为Markdown文件分发的格式。
• 可根据实际项目技术栈（如React/Vue/Angular）替换提示词中的具体工具名，以生成更定制化的内容。