云原生平台文档自动化处理完整流程提示词

角色定义

你应以云原生技术文档架构师或DevOps文档自动化工程师的身份使用本提示词。你的目标是为云原生平台设计一套完整的文档自动化处理流程，将文档生成、校验、发布嵌入到CI/CD流水线中，确保技术文档与基础设施代码同步更新，提升团队交付效率。

适用场景

• 云原生平台的API文档、用户手册、运维指南自动化生成
• Kubernetes、微服务、服务网格等基础设施的文档与代码同步
• CI/CD管道中集成文档构建、测试与部署（如GitOps文档）
• 多版本、多环境的文档自动化管理与版本控制
• 企业级云原生项目文档标准化与自动化审计

核心提示词

• 角色定位：云原生平台文档自动化处理完整流程，从代码仓库到文档站点，包括解析、生成、校验、发布各环节。
• 技术栈关键词：Kubernetes, Helm, Terraform, ArgoCD, GitLab CI/CD, OpenAPI, Swagger, Markdown, MDX, Docsify, Docusaurus, Sphinx, Asciidoc, PlantUML, Mermaid
• 流程关键词：源码注解提取、自动生成接口文档、文档测试、链接检查、格式校验、版本控制、多语言支持、静态站点生成、持续部署
• 可复制提示词示例：“设计一个云原生平台文档自动化流水线，包含代码注释扫描、OpenAPI规范生成、Markdown渲染、文档格式校验、自动部署到静态站点，并集成于GitLab CI中，支持多版本管理。”

风格方向

• 技术架构图风格：使用流程图、泳道图展示文档从源码到发布的完整链路，节点标注每个阶段的工具与输出。
• 系统流程图风格：清晰箭头连接各个自动化步骤，颜色区分不同阶段（如生成、校验、发布）。
• 简洁专业风格：避免多余装饰，强调信息层级，使用统一字体和图标。
• 云原生色调：蓝色、青色、灰色为主，搭配白色背景，体现技术感。

构图建议

• 水平时间线构图：从左到右展示“代码提交→解析注释→生成文档→格式校验→构建站点→部署发布”的线性流程，每个节点下方列出关键工具。
• 环状闭环构图：展示文档自动化与CI/CD的循环反馈，体现版本迭代中文档持续更新。
• 分层架构图：将流程分为“源码层→生成层→校验层→发布层”，每层内列出具体组件。
• 泳道图：区分开发者、CI管道、文档系统、运维人员等多个角色的参与时序。

细节强化

• 在流程图中加入版本标签（如v1.0、v2.0）和分支标识（main、release），体现多版本管理。
• 标注文档测试节点（如链接检查、拼写检查、API响应验证），突出质量保证。
• 使用图标化表示：代码仓库用????、文档生成用⚙️、校验用✅、发布用????。
• 加入数据流箭头和条件判断菱形，展示失败回滚或重新生成逻辑。
• 注明输出格式：如Markdown、HTML、PDF、OpenAPI JSON等。

使用建议

• 在图像生成工具（如Midjourney、DALL·E）中使用上述核心提示词，配合风格方向和构图建议，生成可视化流程图或架构图。
• 如需生成文档效果图，可指定“文档自动化仪表盘”或“CI/CD管道中文档步骤截图”作为输出目标。
• 可根据实际项目调整技术栈关键词（如替换为特定CI工具），保持提示词的灵活性。
• 建议将本提示词作为模板，在团队内部文档自动化方案设计会议中使用，辅助头脑风暴和草图绘制。