智能体开发文档自动化处理结构化提示词

角色定义与任务定位

请以“智能体开发文档架构师”的身份，运用本提示词方案。您的核心目标是：设计一套系统化的指令集，驱动AI模型（如大语言模型）自动完成技术文档的解析、结构化重组、格式标准化或内容摘要生成等任务，确保输出文档符合智能体开发领域的专业规范与逻辑一致性。

适用场景

• 将杂乱的API接口描述自动整理为标准的Markdown格式文档。
• 从会议记录或需求讨论文本中，自动提取并生成结构化的功能规格说明书。
• 对冗长的源代码注释或日志文件进行智能摘要，生成核心流程说明。
• 将非结构化的技术问答（如社区帖子）转换为FAQ知识库条目。
• 跨版本对比智能体配置文件，自动生成版本变更日志。

核心提示词

可直接复制使用的指令模板：

• “请将以下原始文本，严格按照‘概述-输入参数-输出结果-错误代码-示例’的结构，重组为标准的API文档。保留所有技术细节，使用表格呈现参数。”
• “分析提供的对话记录，识别出所有功能需求点，并以‘用户故事：作为[角色]，我希望[目标]，以便[价值]’的格式输出结构化列表。”
• “请对比‘config_v1.yaml’与‘config_v2.yaml’的内容差异，并生成一份分为‘新增配置项’、‘删除配置项’、‘修改配置项’三个部分的变更说明文档。”
• “对以下Python函数注释进行提炼，生成一份包含‘功能简述’、‘算法流程（步骤列表）’、‘时间复杂度分析’的技术备忘录。”

风格方向

• 文体风格：技术手册风格，客观、精确、无歧义。采用主动语态与现在时态。
• 术语规范：统一使用智能体开发领域的标准术语（如：意图识别、槽位填充、对话状态、动作执行）。
• 格式基调：模块化、层级分明。大量使用列表、代码块、表格等元素增强可读性。
• 视觉隐喻：在描述系统架构时，可提示采用“流程图”、“模块依赖图”或“数据流图”的文本描述方式。

构图建议（信息架构）

• 总-分-总结构：文档开头提供全局概述与目录，中间部分展开细节模块，结尾进行总结或提供相关链接。
• 层级递进：从系统概览到模块说明，再到接口/函数细节，信息深度逐层递进。
• 并列陈列：对于多个功能相似或参数并列的部分，使用平行结构进行说明，保持格式一致。
• 焦点引导：通过加粗关键词、使用标题等级，引导读者关注当前段落的重点信息。

细节强化

• 数据呈现：参数表必须包含“字段名、类型、是否必填、默认值、描述”等列。错误代码表需包含“代码、含义、可能原因”。
• 代码示例：提供真实可运行的代码片段，并附有简短注释说明关键行。
• 版本与状态标识：在文档显眼处标注“文档版本”、“适用智能体版本”及“状态（如：草案/已发布）”。
• 交互元素提示：对于需要用户输入的配置项，使用`{placeholder}`格式标明；对于可点击或可操作的UI组件，在描述中指明。
• 约束与边界说明：明确列出功能的限制条件、性能边界、已知问题或依赖项。

使用建议

• 将“核心提示词”中的模板作为与AI交互的初始指令，并将您的原始材料附在其后。
• 在复杂任务中，采用“链式提示”策略：先让AI输出大纲，您审核后再令其填充细节。
• 在提示词中明确指定输出格式（如：Markdown, JSON, YAML），并规定标题层级（如：使用##作为二级标题）。
• 迭代优化：首次输出若不理想，可针对性地补充指令，如“请将参数描述部分更详细化”或“请为每个示例添加一行解释”。
• 本方案同样适用于指导智能体自身处理其知识库文档，实现自我文档化与更新。