跳转至

用户指南目录

02-user-guide 现在只保留三个内容文档:

  1. 使用指南
  2. 提示词速查
  3. 命令速查

这三个文档分别解决什么问题

文档 解决的问题 什么时候读
user-guide.md 第一次接触 shanforge,如何完成安装准备、判断项目类型、开始第一轮会话、日常使用 第一次上手和忘记流程时
prompt-templates.md 不同场景下直接复制什么自然语言 Prompt,应该期待 AI 返回什么 每次真正开工前
command-cheatsheet.md 每个 factory-* 命令做什么、什么时候用、怎么调用、预期生成什么 想从自然语言下钻到具体命令时

推荐阅读顺序

如果你是第一次接触 shanforge

  1. 先读 使用指南
  2. 再读 提示词速查
  3. 最后把 命令速查 当参考手册

如果你已经会用自然语言,但总忘命令

  1. 先读 命令速查
  2. 再回看 提示词速查

如果你知道命令,但总写不好 Prompt

  1. 先读 提示词速查
  2. 再回看 使用指南 中的“第一轮会话怎么开始”

使用边界

  • 这里讲的是“怎么使用 shanforge”
  • 不展开内部实现细节
  • 不承载需求、设计、测试、发布等项目阶段正式文档

如果你只想先看一篇,先看 使用指南