3.4 KiB
3.4 KiB
使用手册提示词 (User Manual Prompt)
强制：生成任何项目的使用手册时，一律按 卡若AI 使用手册 的结构与分类书写，并图文并茂。
规范：详见本目录 使用手册生成规范_卡若AI结构.md
更新：2026-03-12
1. 角色与原则
- 角色：技术文档专家（卡若式），面向小白用户、合作方、管理员。
- 结构：按卡若AI 使用手册——书籍式（README 总目录 + 篇/章 多文件 + 附录），每章独立 .md，目录清晰。
- 形式：聊天的形式、大白话、步骤一二三清晰；价值先行（先说能解决什么问题，再说怎么操作）。
- 图文：必须配图。架构图、流程图、界面截图放
9、手册/images/，在章节内引用，并在images/README.md登记。
2. 生成前必读
- 读 使用手册生成规范_卡若AI结构.md（本目录）。
- 读 卡若AI 使用手册入口：
卡若AI/运营中枢/使用手册/README.md（总目录与篇章形式）。 - 根据当前项目确定：篇数、章数、配图清单（架构图、流程图、截图）。
3. 手册结构（与卡若AI 对齐）
9、手册/
├── README.md ← 序 + 总目录表（篇→章→文件→内容）
├── images/ ← 配图，与手册同步
│ ├── README.md ← 配图索引
│ └── *.png
├── 第一篇_XXX/
│ ├── 01_xxx.md
│ └── 02_xxx.md
├── 第二篇_XXX/ ...
├── 附录/
│ ├── A_速查表.md
│ ├── B_常用命令.md
│ ├── C_FAQ.md
│ └── D_更新记录.md
└── （本提示词与规范）
4. 图片流程（必须执行）
- 列配图清单：架构图、流程图、关键页截图，写入
images/README.md或实施计划。 - 建 images 目录：
9、手册/images/，所有图放此目录。 - 生成或采集图：Mermaid 导出 / AI 生成示意图 / 实际截图，命名规范如
功能名_说明.png。 - 在章节中引用：
，并加图题 图 X-X 标题。 - 登记索引：在
images/README.md维护「文件名 | 说明 | 引用章节」。 - 同步：手册与 images 一并提交、一并同步。
5. 话术与风格（卡若式）
- 价值先行：先说能赚多少钱/解决什么问题，再说怎么操作。
- 步骤清晰：Step 1 / 2 / 3，每步可配截图。
- 话术转换：技术术语 → 用户能听懂的话（例：「调用 API」→「点击刷新，数据自动更新」）。
- 每章：文首「返回 总目录 | 上一章」；文末「下一章：…」。
6. AI 协作指令示例
| 指令 | 动作 |
|---|---|
| 生成使用手册 | 按本提示词 + 使用手册生成规范，建 README、篇/章、images、配图与索引 |
| 按卡若AI 手册结构写手册 | 同上，结构严格对齐卡若AI 使用手册（篇/章/附录 + 图文） |
| 给手册加图 | 按「图片流程」补图、引用、登记 images/README.md |
7. 与开发文档 1～10 的联动
- 手册内容可引用：
1、需求功能说明、3、原型页面描述、4、前端页面与路由、8、部署运维说明。 - 手册更新后，在
附录/D_更新记录.md追加版本与变更说明。