进阶版多语言站点On-Prem私有化文档提示词

2026-05-15阅读 301热度 301

本提示词方案旨在为技术文档工程师或部署专家提供一套结构化、可操作的指导,用于生成适用于企业...

多语言站点 On-Prem 私有化文档 完整流程 文本创作

提示词内容

复制

角色定义与任务定位

请以企业级技术文档架构师的身份,执行本次内容创作。你的核心目标是:为计划进行On-Prem(本地化私有部署)的软件产品,系统化地生成一套专业、清晰、可维护的多语言技术文档。这份文档将作为客户成功团队与终端用户的关键参考资料,需兼顾技术准确性与跨文化语境下的易理解性。

适用场景

  • 为私有化部署的SaaS产品或企业软件编写安装、配置与管理指南。
  • 构建支持多语言(如中、英、日等)的企业内部知识库或客户支持站点。
  • 制定标准化的文档写作规范与本地化流程,确保不同语言版本内容一致。
  • 为售前、交付及运维团队提供结构化的技术说明材料。

核心提示词

以下提示词组合可直接用于引导AI生成或作为您写作的大纲框架:

  • 创作指令:“请以技术文档工程师的身份,撰写一份关于[产品名称] On-Prem私有化部署的详细指南。文档需涵盖从环境准备、安装步骤、初始配置到日常运维的完整流程。要求结构清晰,步骤可操作,术语准确。”
  • 多语言扩展:“基于上述中文文档核心内容,生成其英文版本。请注意:1. 技术术语与产品专有名词需与官方国际版保持一致;2. 将中文语境下的举例转换为更符合全球用户认知的案例;3. 保持相同的章节结构与编号体系。”
  • 流程细化:“详细描述‘高可用集群配置’这一子流程。请分点列出前置检查项、主从节点配置步骤、故障转移测试方法,并附上关键配置文件的代码片段(以YAML格式为例)及参数说明。”

风格方向

  • 文体风格:采用客观、精准、简洁的技术说明文风。避免营销口吻和模糊表述。
  • 逻辑结构:遵循“总-分-总”原则,文档开头提供概述与架构图,中间分模块详述,结尾总结常见问题与获取帮助的途径。
  • 语气把握:保持专业且支持性的语气,预判用户可能遇到的困难,并在关键步骤添加“注意”或“警告”提示框。

构图建议(针对文档视觉辅助元素)

  • 架构图:使用流程图或组件拓扑图,展示On-Prem部署中服务器、网络、存储及外部服务的连接关系。
  • 操作序列图:对于复杂的交互流程(如数据同步、备份恢复),使用序列图或状态转换图进行可视化说明。
  • UI标注图:对管理控制台的关键配置页面进行截图,并使用箭头和编号框清晰标注操作区域与对应参数。
  • 代码/配置块:所有命令行操作和配置文件内容,均需放置在等宽字体的代码块中,并注明适用的环境或版本。

细节强化

  • 术语表:在文档附录建立统一的术语表,明确每个核心术语在中文和对应目标语言中的标准译法。
  • 版本标识:在文档页眉或页脚清晰标注文档版本号、对应的产品版本号以及最后更新日期。
  • 变量与占位符:所有需要用户根据实际情况替换的内容(如IP地址、域名、密钥),使用统一的占位符格式,例如:{your_server_ip}<您的企业标识>
  • 跨文化适配:在多语言版本中,检查日期格式、货币单位、度量衡以及所有文化特定隐喻,确保其符合目标读者群体的习惯。

使用建议

  • 首先使用“核心提示词”中的“创作指令”生成文档主干。
  • 针对每个主要章节,可运用“流程细化”提示词进行深度扩充,生成子章节内容。
  • 完成主体内容后,再使用“多语言扩展”提示词进行批量翻译与本地化适配,而非逐句翻译,以保持逻辑连贯性。
  • 将“构图建议”与“细节强化”中的要点,作为文档审核与质量检查的清单,确保产出物的专业度与实用性。
  • 本方案生成的文本内容,可直接导入Confluence、GitBook等文档平台,或作为Markdown文件进行版本管理。

常见问题

相关提示词

更多
欢迎回来 登录或注册后,可保存提示词和历史记录
登录后可同步收藏、历史记录和常用模板
注册即表示同意服务条款与隐私政策