产品文档规划设计
此提示旨在帮助专业人士和技术写作者为产品制定全面、系统的文档规划,确保文档符合产品特点、目标用户和组织需求。使用此提示,用户可以系统化地规划文档类型、模板、工作流程及高质量内容的创建过程。它尤其适用于软件开发人员、产品经理、技术写作者及文档团队,确保文档内容一致、清晰且覆盖完整。该提示指导AI生成可执行的计划,包括文档类型、模板、风格指南、用户角色、发布时间表及审核流程,有效解决常见问题,如文档分散、格式不统一、责任不明确以及功能覆盖不足。使用此提示可加快文档规划速度、提升团队协作效率、标准化模板,并为作者和审阅者提供明确指导,从而确保产品文档完整、用户导向、专业且符合业务目标。
AI 提示词
使用方法
1. 将\[产品名称]替换为实际的产品或项目名称。
2. 为获得更精准的结果,提供产品类型、复杂度及目标用户等详细信息。
3. 将提示输入支持文本生成的AI工具。
4. 审核生成的文档规划,必要时调整时间表、职责或文档类型。
5. 利用规划协调团队、确定模板及制定交付期限。
6. 避免提供模糊的产品描述,信息越具体,生成结果越准确。
使用案例
软件用户手册及指南规划
 开发者门户API文档创建
 版本说明及变更日志准备
 企业文档模板标准化
 团队文档职责协调
 硬件或物联网设备技术文档开发
 支持团队内部知识库建设
 新员工入职文档整理
专业技巧
提供产品功能的详细信息以提升规划准确性。
 根据团队能力和项目范围调整时间表。
 从一开始就纳入风格和品牌元素以确保一致性。
 将规划视为动态文档,随产品更新而调整。
 可请求AI生成表格或可视化图表以增强可读性。
相关提示词
用户手册编写设计指南
本高级提示旨在帮助技术写作人员、产品经理、工程师以及支持团队创建完整、结构化且专业的用户手册,适用于软件、设备或服务。通过使用此提示,用户能够生成清晰且详细的文档,使终端用户能够轻松理解复杂的技术信息,同时保证技术准确性。提示涵盖用户手册的各个核心部分,包括产品介绍、主要功能、安装与使用说明、高级设置、故障排除提示以及必要时的实际示例。它解决了技术信息难以理解、章节间缺乏一致性以及操作步骤易出错等常见问题。使用该提示可以提升用户满意度,优化产品采纳率,并减少技术支持请求,同时节省编写手册的时间,并确保文档的专业性和规范性。
请为\[产品名称/软件/服务]创建一份完整、结构化且专业的用户手册。手册应包含以下内容:产品介绍、主要功能、安装与使用说明、高级设置、故障排除提示及必要时的实际示例。请确保语言清晰、简洁且易于理解。使用标题、子标题和项目符号列表以增强可读性。添加重要提示或注意事项以确保产品的安全和有效使用。手册应以易于浏览和理解的格式呈现。
制定技术文档策略
此提示旨在帮助专业人员为其组织、产品或项目制定全面的技术文档策略。适用于技术写作人员、产品经理、软件工程师及文档团队,旨在结构化、标准化并优化文档创建流程。通过使用此提示,用户可以生成包含文档类型、目标受众分析、内容标准、工作流程以及维护和更新策略的详细计划。该提示可解决常见问题,如文档不一致、受众不明确、缺乏模板以及更新流程低效。使用此提示,团队可以确保所有技术材料——包括用户手册、API参考、故障排除指南和内部知识库——均清晰、一致且易于维护。最终结果是一份专业、清晰且可直接执行的策略,能够提升团队沟通效率、减少错误、提高用户满意度,同时在未来的文档项目中节省时间。
为\[项目/产品名称]制定详细的技术文档策略。请包含以下部分: 1. 目标受众分析:识别主要和次要用户及其文档需求。 2. 文档类型:列出所需文档类型(用户手册、API参考、故障排除指南、内部文档等)。 3. 内容标准:定义文档风格、语气、格式、模板及版本控制。 4. 工作流程与过程:描述文档的创建、审核、批准和发布流程。 5. 工具与平台:推荐文档创建、协作和存储工具。 6. 维护与更新:提出文档更新和归档的流程。 7. 指标与KPI:确定衡量文档有效性的方法。 …
使用说明书设计策略
此提示旨在帮助专业人士、技术写作人员和培训设计师制定全面的使用说明书设计策略。通过使用该提示,用户可以结构化内容、深入分析目标受众,并确保说明书的内容清晰、准确且易于理解。它能够解决常见问题,例如指令不明确、版式混乱以及用户理解困难。同时,提示提供了对视觉元素(如图表、截图、表格和图标)的使用建议,并对写作风格、排版和可读性提供指导。该提示特别适用于需要多步骤规划、战略性思考和高度内容准确性的复杂技术项目。工程师、软件开发人员、生产或培训专业人士可利用此提示创建标准化、用户导向的说明书,从而减少错误、提升知识传递效率并提高用户满意度。
为\[产品/流程/系统]制定完整的使用说明书设计策略。策略应包括: 1. 目标受众分析(经验水平、先前知识、特定需求)。 2. 内容结构(章节、主要标题和子标题)。 3. 指令的清晰度与语气(技术术语、简明、写作风格)。 4. 视觉元素建议(图表、表格、截图、图标)。 5. 排版与布局指导(字体、行间距、可读性)。 6. 测试和反馈方法,以确保使用说明书的可用性。 请提供一个明确、可执行的计划,包括最佳实践、潜在挑战及建议,以创建高效的使用说明书。
制定软件文档计划
此提示旨在帮助专业人员创建全面的软件文档计划,特别适用于软件开发团队、产品经理和技术写作人员。通过此提示,用户可以系统地规划文档的内容、结构和流程,包括目标受众分析、文档范围定义、关键部分的优先级排序以及资源的高效分配。一个良好设计的文档计划可以确保文档一致性、优化信息流,并减少临时解释或问题解决所需的时间。该提示尤其适用于新产品发布、现有软件更新或新开发者加入团队的场景,提供清晰有序的方法来记录复杂系统。其优势包括提升项目透明度、优化团队沟通以及改善内部和外部用户体验。此外,该计划可适用于各种类型的软件,从 Web 应用到企业级系统,使其成为技术写作和知识管理专业人士的多功能工具。
为项目 \[项目或软件名称] 制定详细的软件文档计划。计划应包含以下内容: 1. 目标受众及用户画像 2. 文档目标和用途 3. 主要章节(如用户指南、API 参考、问题排查) 4. 内容结构和层级 5. 风格、语气和格式指南 6. …
构建技术内容策略
本提示旨在帮助专业人士、内容经理和技术作者制定全面且可执行的技术内容策略。它指导 AI 分析目标受众、行业趋势和内容目标,并生成一份结构化的内容创建、分发与优化路线图。使用此提示,用户可以获得实用的策略,提升文档、教程、博客及知识库的清晰度、用户参与度和知识传递效率,同时保证技术内容的一致性。 该提示解决了常见问题,例如内容优先级的确定、现有资料的内容空白识别以及内容工作与业务目标的对齐。最终产出的是一份详细且可直接实施的策略,能够节省时间并提升技术沟通效率。它特别适用于希望以战略性和专业性优化产品文档、用户手册、API 参考或知识管理系统的用户。
“请作为技术内容策略专家,为\[公司/产品/项目名称]制定一份详细的技术内容策略。策略应包括: 1. 受众分析:确定目标用户及其知识水平。 2. 内容目标:定义目标、KPI 及预期结果。 3. 内容类型:推荐适用的格式和渠道(如文档、教程、FAQ、博客)。 4. 路线图:提供优先级计划,包括时间表和关键里程碑。 5. 空白分析:识别缺失的内容及改进空间。 6. 风格与语气建议:确保技术写作规范统一。 7. …
知识库创建开发
该提示旨在帮助专业人士、技术写作人员和知识管理者创建全面且结构化的知识库,适用于组织、产品或服务。它指导 AI 生成有组织的内容,包括文章、常见问题解答(FAQ)、分步骤指南以及文档模板,同时确保风格、语气和格式的一致性。使用此提示,用户可以集中管理和结构化企业知识,使其对员工、客户和利益相关者易于访问。这有助于减少重复咨询,提高培训和入职效率,优化客户支持,并确保文档内容始终更新。该提示特别适用于大型知识库项目,可根据技术、流程或产品相关内容进行定制。借助此提示,组织可以集中信息、扩展业务操作,并以专业和系统化的方式保证共享知识的质量和准确性,从而提升整体运营效率和用户体验。
“请作为技术写作与知识管理专家,为 \[主题/组织/产品] 创建一套完整的知识库。请将知识库按主分类、子分类和清晰的文章标题进行结构化。每篇文章应包括: 1. 标题 2. 摘要(简要概述) 3. 分步骤操作指南或详细说明 4. 常见问题解答(FAQ) 5. 提示、注意事项或最佳实践 确保内容清晰、专业,且适合 \[目标受众]。保持风格和语气一致,并在必要时建议文章间的内部链接。将知识库呈现为结构化且易于阅读的格式,便于直接集成到知识管理系统中。”
更多来自 技术写作
制定技术文档策略
此提示旨在帮助专业人员为其组织、产品或项目制定全面的技术文档策略。适用于技术写作人员、产品经理、软件工程师及文档团队,旨在结构化、标准化并优化文档创建流程。通过使用此提示,用户可以生成包含文档类型、目标受众分析、内容标准、工作流程以及维护和更新策略的详细计划。该提示可解决常见问题,如文档不一致、受众不明确、缺乏模板以及更新流程低效。使用此提示,团队可以确保所有技术材料——包括用户手册、API参考、故障排除指南和内部知识库——均清晰、一致且易于维护。最终结果是一份专业、清晰且可直接执行的策略,能够提升团队沟通效率、减少错误、提高用户满意度,同时在未来的文档项目中节省时间。
为\[项目/产品名称]制定详细的技术文档策略。请包含以下部分: 1. 目标受众分析:识别主要和次要用户及其文档需求。 2. 文档类型:列出所需文档类型(用户手册、API参考、故障排除指南、内部文档等)。 3. 内容标准:定义文档风格、语气、格式、模板及版本控制。 4. 工作流程与过程:描述文档的创建、审核、批准和发布流程。 5. 工具与平台:推荐文档创建、协作和存储工具。 6. 维护与更新:提出文档更新和归档的流程。 7. 指标与KPI:确定衡量文档有效性的方法。 …
开发 Api 文档框架
本提示旨在帮助技术写作人员、软件开发者及 API 团队构建结构化且完整的 API 文档框架。它指导用户定义文档中应包含的核心组成部分,包括 API 概览、端点(endpoints)、请求与响应格式、身份验证方法、错误处理机制、实际示例及版本管理策略。使用此提示可以生成一致、清晰且易于理解的文档,从而提高开发者效率并减少支持请求。该框架适用于 REST、GraphQL 及其他 API 架构,同时可作为自动化文档工具、开发者门户或内部知识库的基础。此外,它有助于团队协作,加快文档创建流程,并保证高质量输出。最终,用户将获得专业、结构化、易于访问的文档,为内部与外部开发者提供优化体验,并支持 API 的可扩展性和维护性。
为 \[项目/API 名称] 创建完整的 API 文档框架。文档框架应包括以下内容: 1. API 概览及目标 2. 身份验证与授权方法 3. 端点列表及说明 4. 请求与响应格式示例 …
用户手册编写设计指南
本高级提示旨在帮助技术写作人员、产品经理、工程师以及支持团队创建完整、结构化且专业的用户手册,适用于软件、设备或服务。通过使用此提示,用户能够生成清晰且详细的文档,使终端用户能够轻松理解复杂的技术信息,同时保证技术准确性。提示涵盖用户手册的各个核心部分,包括产品介绍、主要功能、安装与使用说明、高级设置、故障排除提示以及必要时的实际示例。它解决了技术信息难以理解、章节间缺乏一致性以及操作步骤易出错等常见问题。使用该提示可以提升用户满意度,优化产品采纳率,并减少技术支持请求,同时节省编写手册的时间,并确保文档的专业性和规范性。
请为\[产品名称/软件/服务]创建一份完整、结构化且专业的用户手册。手册应包含以下内容:产品介绍、主要功能、安装与使用说明、高级设置、故障排除提示及必要时的实际示例。请确保语言清晰、简洁且易于理解。使用标题、子标题和项目符号列表以增强可读性。添加重要提示或注意事项以确保产品的安全和有效使用。手册应以易于浏览和理解的格式呈现。
制定软件文档计划
此提示旨在帮助专业人员创建全面的软件文档计划,特别适用于软件开发团队、产品经理和技术写作人员。通过此提示,用户可以系统地规划文档的内容、结构和流程,包括目标受众分析、文档范围定义、关键部分的优先级排序以及资源的高效分配。一个良好设计的文档计划可以确保文档一致性、优化信息流,并减少临时解释或问题解决所需的时间。该提示尤其适用于新产品发布、现有软件更新或新开发者加入团队的场景,提供清晰有序的方法来记录复杂系统。其优势包括提升项目透明度、优化团队沟通以及改善内部和外部用户体验。此外,该计划可适用于各种类型的软件,从 Web 应用到企业级系统,使其成为技术写作和知识管理专业人士的多功能工具。
为项目 \[项目或软件名称] 制定详细的软件文档计划。计划应包含以下内容: 1. 目标受众及用户画像 2. 文档目标和用途 3. 主要章节(如用户指南、API 参考、问题排查) 4. 内容结构和层级 5. 风格、语气和格式指南 6. …
创建流程文档框架
此提示旨在帮助企业和专业人员建立系统化、标准化的流程文档框架,以确保业务流程清晰、可控并易于管理。通过使用该提示,用户可以生成涵盖流程目标、范围、详细步骤、角色与责任、所用工具、输出结果及监控指标的完整文档结构,从而提升组织内部的工作效率和流程透明度。 该提示适用于技术写作人员、项目经理、业务分析师、质量管理人员以及企业培训团队等专业人士。它解决了流程不统一、文档缺失或信息分散等常见问题,减少重复工作与误操作,提高新员工培训的效率,并支持企业合规性和质量管理要求。 通过应用此提示,组织能够快速建立标准化文档模板,便于跨部门沟通、流程改进以及知识管理。无论是复杂的业务流程、IT系统操作流程,还是生产运营流程,该提示都能生成结构清晰、可直接使用的专业文档框架,帮助企业实现流程可视化和管理优化。
请扮演专业的技术写作人员,根据以下信息创建完整的流程文档框架: 流程名称:\[填写流程名称] 流程目标:\[填写流程目标] 流程范围:\[描述流程适用范围和边界] 流程步骤:\[逐步列出详细操作] 角色与责任:\[列出每个步骤的负责人] 使用工具/系统:\[列出所用软件、硬件或方法] 输出结果/交付物:\[明确预期成果] 监控与评估指标:\[描述衡量流程成功的标准] 请以清晰、专业、结构化的形式输出文档框架,可直接用于企业内部使用。
使用说明书设计策略
此提示旨在帮助专业人士、技术写作人员和培训设计师制定全面的使用说明书设计策略。通过使用该提示,用户可以结构化内容、深入分析目标受众,并确保说明书的内容清晰、准确且易于理解。它能够解决常见问题,例如指令不明确、版式混乱以及用户理解困难。同时,提示提供了对视觉元素(如图表、截图、表格和图标)的使用建议,并对写作风格、排版和可读性提供指导。该提示特别适用于需要多步骤规划、战略性思考和高度内容准确性的复杂技术项目。工程师、软件开发人员、生产或培训专业人士可利用此提示创建标准化、用户导向的说明书,从而减少错误、提升知识传递效率并提高用户满意度。
为\[产品/流程/系统]制定完整的使用说明书设计策略。策略应包括: 1. 目标受众分析(经验水平、先前知识、特定需求)。 2. 内容结构(章节、主要标题和子标题)。 3. 指令的清晰度与语气(技术术语、简明、写作风格)。 4. 视觉元素建议(图表、表格、截图、图标)。 5. 排版与布局指导(字体、行间距、可读性)。 6. 测试和反馈方法,以确保使用说明书的可用性。 请提供一个明确、可执行的计划,包括最佳实践、潜在挑战及建议,以创建高效的使用说明书。
构建技术内容策略
本提示旨在帮助专业人士、内容经理和技术作者制定全面且可执行的技术内容策略。它指导 AI 分析目标受众、行业趋势和内容目标,并生成一份结构化的内容创建、分发与优化路线图。使用此提示,用户可以获得实用的策略,提升文档、教程、博客及知识库的清晰度、用户参与度和知识传递效率,同时保证技术内容的一致性。 该提示解决了常见问题,例如内容优先级的确定、现有资料的内容空白识别以及内容工作与业务目标的对齐。最终产出的是一份详细且可直接实施的策略,能够节省时间并提升技术沟通效率。它特别适用于希望以战略性和专业性优化产品文档、用户手册、API 参考或知识管理系统的用户。
“请作为技术内容策略专家,为\[公司/产品/项目名称]制定一份详细的技术内容策略。策略应包括: 1. 受众分析:确定目标用户及其知识水平。 2. 内容目标:定义目标、KPI 及预期结果。 3. 内容类型:推荐适用的格式和渠道(如文档、教程、FAQ、博客)。 4. 路线图:提供优先级计划,包括时间表和关键里程碑。 5. 空白分析:识别缺失的内容及改进空间。 6. 风格与语气建议:确保技术写作规范统一。 7. …
知识库创建开发
该提示旨在帮助专业人士、技术写作人员和知识管理者创建全面且结构化的知识库,适用于组织、产品或服务。它指导 AI 生成有组织的内容,包括文章、常见问题解答(FAQ)、分步骤指南以及文档模板,同时确保风格、语气和格式的一致性。使用此提示,用户可以集中管理和结构化企业知识,使其对员工、客户和利益相关者易于访问。这有助于减少重复咨询,提高培训和入职效率,优化客户支持,并确保文档内容始终更新。该提示特别适用于大型知识库项目,可根据技术、流程或产品相关内容进行定制。借助此提示,组织可以集中信息、扩展业务操作,并以专业和系统化的方式保证共享知识的质量和准确性,从而提升整体运营效率和用户体验。
“请作为技术写作与知识管理专家,为 \[主题/组织/产品] 创建一套完整的知识库。请将知识库按主分类、子分类和清晰的文章标题进行结构化。每篇文章应包括: 1. 标题 2. 摘要(简要概述) 3. 分步骤操作指南或详细说明 4. 常见问题解答(FAQ) 5. 提示、注意事项或最佳实践 确保内容清晰、专业,且适合 \[目标受众]。保持风格和语气一致,并在必要时建议文章间的内部链接。将知识库呈现为结构化且易于阅读的格式,便于直接集成到知识管理系统中。”