MCP工具产品说明文档结构化提示词

角色定义与任务定位

请以一名资深技术文档工程师或产品专家的身份，运用结构化思维与清晰的表达能力，完成以下核心任务：为特定的MCP工具创作一份逻辑严谨、层次分明、便于用户理解与操作的产品说明文档。你的目标是产出可直接用于开发、部署或用户引导的专业文本内容，而非泛泛而谈的介绍。

适用场景

• 为新开发的MCP工具撰写首次发布的官方产品说明文档。
• 为现有MCP工具的功能更新或版本迭代补充或修订说明文档。
• 为内部开发团队或外部合作伙伴提供清晰的技术集成与使用指南。
• 将零散的功能点整合为体系化的用户帮助文档或知识库文章。

核心提示词

请基于以下结构化框架组织内容，并填充具体信息：

• 文档标题： [MCP工具名称] 产品说明文档 v[版本号]
• 概述与定位： 简明阐述该工具的核心价值、解决的问题及目标用户群体。
• 核心功能列表： 使用条目清晰列出主要功能点，每个功能点附一句简要说明。
• 快速开始指南： 提供从环境准备、安装配置到运行第一个示例的最小可行步骤。
• 详细使用说明： 对每个核心功能进行分节说明，包含使用场景、输入输出参数、配置选项及示例代码片段。
• 实战应用案例： 描述1-2个典型业务场景下的完整应用流程，展现工具如何串联使用。
• 常见问题与排错： 整理部署和使用中可能遇到的常见问题及其解决方案。
• 附录与参考： 包含API接口详情、配置项全量说明、版本更新日志等。

风格方向

• 语言风格： 专业、准确、客观。避免营销化口语，使用肯定句和主动语态。
• 结构风格： 层级分明，遵循“总-分-总”或“概述-细节-案例”的逻辑。大量使用小标题、编号列表和项目符号。
• 表述风格： 直指要点，避免冗长铺垫。对专业术语首次出现时可稍作解释，后续直接使用。

构图建议（信息组织）

• 采用“金字塔原理”，将最重要的结论和概述置于文档开头。
• 功能说明部分采用“功能定义 -> 为何需要 -> 如何使用 -> 示例展示”的四段式结构。
• 复杂流程建议使用“步骤1， 步骤2...”的序列化描述，并可考虑用流程图伪代码或缩进格式辅助说明。
• 将技术参数、命令行选项等格式化内容放入代码块或表格中，与叙述性文字明显区分。

细节强化

• 一致性： 确保全文档术语统一（如始终称“模型上下文协议”或始终使用缩写“MCP”）。
• 可操作性： 所有步骤说明应确保用户按图索骥即可执行，避免缺失关键操作或前提条件。
• 示例驱动： 为关键功能提供简短、可运行的示例代码或配置片段，并注释关键行。
• 视觉辅助提示： 在文本中标注可放置架构图、序列图或UI截图的位置，例如“（此处可配工具架构图）”。

使用建议

• 在动笔前，先用核心提示词中的框架搭建文档骨架，填充各级标题。
• 撰写时，时刻想象目标读者（如开发者、运维人员）的知识背景和阅读目的。
• 完成初稿后，通读检查逻辑流是否顺畅，并尝试模拟用户操作，验证指南的准确性。
• 可将此结构化提示词本身作为模板，为不同的MCP工具快速生成新的文档草稿。