Files
karuo-ai/运营中枢/参考资料/使用手册生成_任务提示词.md

5.6 KiB
Raw Permalink Blame History

使用手册生成 · 任务提示词(优化版)

用于生成「带图、分步骤、全架构」的项目使用手册。执行前请先明确目标项目卡若AI、某产品后台、某网站等。 版本1.0 | 更新2026-02-20


一、任务目标(一句话)

[项目名称] 编写一份带图使用手册:读者能按步骤完成操作,并理解整体架构与使用规则;手册内图片与程序界面一致,版面为白底、分板块、可展示图片。


二、执行前必读(输入条件)

执行本提示词前,请确认或由用户补充:

说明 示例
目标项目 手册针对哪个系统/产品/仓库 卡若AI、分布式算力矩阵网站、存客宝
目标读者 访客 / 开发者 / 运营 / 管理员 访客与开发者
手册存放位置 文档与图片的根路径 项目内 9、手册/,或 卡若Ai的文件夹/报告/
图片来源 用真实截图 或 AI 按界面描述生成 优先真实截图;无则生成与程序一致的示意图

若未指定,默认:项目 = 当前对话所在仓库/项目,手册 = 项目内 9、手册/使用手册(带图).md,配图 = 9、手册/images/


三、交付物清单(强制)

  1. 主文档

    • 格式Markdown.md),便于在 IDE / 文档平台中正确展示图片
    • 图片引用:使用相对路径,如 ![说明](images/xxx.png),确保文档与 images/ 同层级或路径正确。
  2. 图片资源

    • 每个关键步骤、每个主要界面/模块至少一张图。
    • 图片风格与程序界面一致:若为现有系统,优先使用真实截图;若为设计稿或暂无产品,可用「与程序 UI 一致的示意图」并注明。
    • 命名建议:步骤N_模块名_简短描述.png(如 步骤2_工作台_首页.png)。
  3. 文档结构(必须包含的板块)

    • 1. 全景架构:系统/产品整体架构图 + 简短说明(模块、角色、数据流)。
    • 2. 使用前准备:环境、账号、权限、依赖(如有)。
    • 3. 分模块操作说明:每个功能板块单独一节,每节含:
      • 本节目标
      • 操作步骤(编号列表)
      • 每步配图(界面截图或与程序一致的示意图)
      • 使用规则与注意事项(可选子小节)
    • 4. 常见问题与规则汇总FAQ + 使用规则/限制(如权限、频率、数据范围)。
    • 5. 附录(可选):术语表、快捷操作、更新记录。
  4. 版面与可读性

    • 底色:白底(在 Markdown 中不强制背景色,导出 PDF/Word 时指定白色背景)。
    • 分节清晰:一级标题 = 大板块,二级 = 模块或子流程,三级 = 具体步骤或规则。
    • 图片与文字对应:每张图下方或段落内注明「图 xxxx」避免图与文脱节。

四、执行步骤(给 AI 的指令)

  1. 分析项目

    • 通读目标项目代码结构、README、已有文档、界面/路由)。
    • 列出:主要模块、用户角色、核心操作路径、与「使用手册」相关的现有资源(如已有截图、设计稿)。
  2. 定结构

    • 按「三、交付物清单」定好手册目录1 全景架构 → 2 使用前准备 → 3 分模块操作 → 4 常见问题与规则 → 5 附录)。
    • 为每个模块列出「必须配图的步骤」清单。
  3. 准备图片

    • 有现成程序/可运行环境:按步骤截图,命名后放入约定 images/ 目录。
    • 无现成界面:根据代码/设计说明生成「与程序界面一致的示意图」,并注明「示意图,实际以产品为准」。
    • 所有生成的图片放入约定目录,并在 卡若Ai的文件夹/图片/图片索引.md 登记(若使用规范中的对外输出目录)。
  4. 撰写正文

    • 按目录逐节写:先架构图与说明,再准备与步骤,再分模块「步骤 + 配图 + 规则」。
    • 每步操作:动作明确(点击哪里、输入什么、看到什么结果),配图与步骤一一对应。
    • 使用规则:每板块结尾可加「使用规则」子小节(权限、限制、建议)。
  5. 自检

    • 在本地或预览中打开 Markdown确认所有图片路径正确、能展示。
    • 确认:白底导出时无大面积深色背景、结构清晰、无遗漏模块。

五、输出位置约定与卡若AI 规范对齐)

  • 手册文档:若为「项目内手册」→ 项目内 9、手册/使用手册(带图).md(或用户指定路径)。
  • 手册用图:项目内 9、手册/images/(或用户指定);若为「对外输出」→ 卡若Ai的文件夹/图片/,并在 图片/图片索引.md 登记来源 Skill、生成者、日期、说明。
  • 本提示词路径运营中枢/参考资料/使用手册生成_任务提示词.md

六、可直接复制的「一句话任务」(给用户/AI

通用版:
请按 运营中枢/参考资料/使用手册生成_任务提示词.md[项目名] 编写带图使用手册:先分析项目并画出全景架构,再按模块写分步操作(每步配与程序一致的图),最后补常见问题与使用规则;手册为 Markdown、白底、图片路径正确可展示。

简短版:
[项目名] 写一份带图使用手册:全景架构 + 分模块步骤说明 + 每步配图(与程序一致)+ 使用规则与 FAQMarkdown、白底、图能正常展示。