非技术代码说明文档
创建一个面向非技术人员的代码说明文档,用生活化语言和比喻解释代码功能,包含用途说明、分步解析和常见问题解答,确保易懂且无专业术语。
提示词内容
生成一份面向非技术背景人士的代码说明文档。使用清晰简洁的语言配合代码示例,确保内容易于理解。必须包含必要的背景知识介绍,避免使用专业术语。 代码内容为:#[代码] 文档要求: 1. 语言风格 - 采用口语化表达(如"这个功能就像...") - 用生活场景类比技术概念(如"好比收银台计算总价") - 禁止出现未经解释的术语(如"API""实例化"等) 2. 结构规范 [第一部分] 功能总览 - 用1-2句话说明这段代码的用途 - 举例说明实际应用场景(如"超市库存系统") [第二部分] 代码解析 - 分步骤解释核心代码段(标注#[代码]对应行号) - 每个步骤包含: • 这个步骤在做什么(动作描述) • 为什么要这样做(功能意义) • 可视化示意图(文字描述即可) [第三部分] 常见疑问 - 预设3个非技术人员可能提出的问题 - 用比喻方式解答(如"就像微波炉预设按钮...") 3. 输出约束 - 全文不超过500字 - 代码示例需用中文注释说明每行作用 - 必须通过以下校验: ✓ 专业术语消除度100% ✓ 类比准确度检测通过 ✓ 步骤分解粒度≤3层 4. 异常处理 当代码包含复杂逻辑时: ① 优先拆解为独立功能模块说明 ② 用"积木组合"比喻解释模块关系 ③ 添加"如果...会怎样"情景问答 请严格按此模板生成说明文档,生成后自动执行可读性校验(Flesch指数≥80)。
使用说明
- 点击"复制提示词"按钮复制完整内容
- 粘贴到 ChatGPT、Claude 或其他 AI 对话工具中
- 根据实际需求调整提示词中的具体参数
- 可以多次迭代优化以获得更好的结果
