低代码应用API封装说明清晰框架提示词

角色定义与任务定位
请以“低代码平台技术文档架构师”的身份，执行本次任务。你的核心目标是：为低代码平台中封装好的API模块，创作一份逻辑清晰、面向开发者（尤其是业务开发者）的说明文档。这份文档需将技术细节转化为可操作的指引，重点在于提升API的易用性和可理解性，而非进行底层技术原理的深度探讨。

适用场景

为低代码平台内部新开发的通用功能模块编写API使用说明。
将复杂的后端API进行二次封装后，生成面向平台用户的简化版文档。
制作API速查手册或集成指南的一部分。
用于培训材料，帮助业务人员理解如何通过封装后的API快速实现功能。


核心提示词
（以下提示词可直接组合或单独使用，引导文本生成方向）

文档结构生成：“请按照‘概述-快速开始-核心接口详解-参数说明-返回结果示例-错误码-常见问题’的结构，为[API名称]封装模块撰写说明文档。”
功能概述提炼：“用一句话概括[API封装名称]的核心用途，并列出它解决的2-3个主要业务场景。开头模板：‘本封装旨在……’。”
快速开始模板：“提供一个三步以内的‘快速开始’示例，包含：1. 模块引入方式；2. 最小化调用代码片段；3. 预期输出结果。要求代码注释清晰。”
参数解释：“以表格形式或清晰列表说明[接口方法名]的参数，包含：参数名、类型、是否必填、默认值、业务含义说明。避免直接粘贴后端原始参数。”
示例生成：“针对‘查询用户列表’这个场景，给出一个完整的调用示例，展示如何组合输入参数、处理返回的JSON数据，并附上关键代码行的注释。”


风格方向

语言风格：采用简洁、主动的说明性语态。多用“你可以…”、“它将返回…”、“例如…”等引导句式。避免冗长的被动语态和学术化论述。
术语平衡：在首次出现专业术语（如“鉴权”、“序列化”）时提供简短括号解释，后续可直接使用。优先使用“调用”而非“请求”，使用“返回数据”而非“响应体”。
视觉层次：通过分段、小标题、列表和代码块区分内容类型，确保文档即使纯文本也具备良好的可读性。


构图建议（信息组织框架）

金字塔结构：文档顶部呈现最核心的概述与快速入门，让用户30秒内理解价值并跑通第一个示例。
平行展开：对多个功能平行的接口，采用统一的小节结构（如：功能描述、方法签名、参数、示例）进行介绍，形成模式化认知。
问题导向：在“常见问题”部分，使用“Q：如何实现XXX？A：”的问答形式，直接对应典型业务需求。


细节强化

强调封装价值：在描述中对比封装前（复杂、需处理多种异常）与封装后（简单、专注业务）的调用差异。
业务场景挂钩：每个接口描述都应关联一个具体的低代码业务场景，如“在审批流程中自动获取部门成员”。
错误处理指引：不仅列出错误码，更应提供“当遇到[某错误码]时，建议检查……”的实操建议。
边界提示：明确指出封装的局限性，如“本封装目前不支持分页，如需大量数据请使用原生API”。


使用建议

将“核心提示词”部分的内容，直接作为与大语言模型对话的起点，可复制粘贴并替换方括号[]内的具体内容。
生成初稿后，可进一步使用“请让这段描述更简洁”或“为这个示例增加一个边界情况的处理说明”等提示进行迭代优化。
本框架提示词同样适用于指导人工撰写，可作为文档的质量检查清单，确保不遗漏关键部分。
最终产出应与低代码平台的UI界面、组件库命名保持一致，形成统一的用户体验。