多语言站点On-Prem私有化文档结构化提示词
本提示词方案专为多语言On-Prem私有化文档的创作与结构化而设计,旨在帮助技术文档工程师或内容...
提示词内容
复制角色定义与任务定位
请以技术文档工程师兼多语言内容架构师的身份,运用本提示词方案。您的核心目标是:为部署在客户本地环境(On-Prem)的软件系统,创作与维护一套高质量、结构化清晰、风格一致且支持多语言版本的私有化产品文档。
适用场景
- 为私有化部署的软件编写安装指南、配置手册与管理文档。
- 维护同一套文档的英文、中文等多语言平行版本,确保技术准确性一致。
- 构建企业内部知识库,用于客户技术支持与工程师培训。
- 生成API接口文档、系统架构说明等需要高度结构化的技术内容。
核心提示词
可直接复制并填充具体产品信息后使用的基础提示词框架:
- “作为技术文档工程师,为[产品名称]的On-Prem私有化部署版本,撰写一份详细的安装部署指南。文档需包含系统要求、环境准备、分步安装流程、初始配置及常见故障排查。确保语言专业、步骤清晰,适用于企业IT管理员。”
- “生成一份关于[功能模块]的API参考文档。要求结构包含:接口概述、请求参数说明(类型、必填、示例)、响应数据结构、状态码列表及调用示例。采用中英双语对照格式。”
- “编写一份面向最终用户的[模块名称]操作手册。以任务为导向,通过‘目标-步骤-结果’的结构进行说明,并配以必要的界面元素说明(如按钮、菜单路径)。风格需简洁、直观,避免过度技术化。”
风格方向
- 专业严谨:使用准确的技术术语,避免歧义和口语化表达。语气正式、客观。
- 清晰一致:保持全文档术语统一、标题层级分明、句式结构工整。多语言版本间除语言转换外,风格与结构需完全对应。
- 实用导向:以解决用户实际问题为核心,侧重操作步骤、配置项说明和解决方案。
- 模块化:内容应可被拆分为独立的章节或主题,便于按需阅读和后续更新。
构图建议(信息结构)
- 层级化标题:采用“文档标题 > 章节标题 > 小节标题 > 子段落”的清晰层级。
- 清单体与步骤体:对于系统要求、前提条件、枚举项,使用无序列表;对于操作流程,使用带序号的步骤列表。
- 代码块与表格化:命令行操作、配置文件示例放入等宽字体代码块;参数说明、版本对比等信息使用表格呈现。
- 图文呼应区:在提示词中为关键步骤预留插图说明位置,例如“(此处可配图:服务器网络拓扑示意图)”。
细节强化
- 环境特异性:明确标注该文档仅适用于On-Prem环境,并指出与SaaS版本的差异点。
- 变量与占位符:对需要用户替换的内容,如IP地址、文件名、密码,使用尖括号或高亮标识,例如
<your_server_ip>。 - 多语言处理:在提示词中指定目标语言,并要求专业的技术翻译,而非字面直译。保留术语表以确保一致性。
- 版本与警示信息:包含文档适用的软件版本号,对关键操作或风险步骤添加“注意”、“警告”等提示框。
使用建议
- 在使用核心提示词时,请将方括号[]内的占位符替换为您的具体产品名、模块名或版本号。
- 生成内容后,务必进行技术准确性复核,特别是命令、参数和配置路径。
- 对于多语言版本,建议先完成源语言(如英文)主文档的定稿,再以其为基准进行本地化,以保持技术内容同步。
- 可将“风格方向”与“构图建议”中的要点作为内容质量的检查清单,确保产出符合标准。