跳转至

入门说明

本目录面向第一次接触 shanforge 的读者,解决三个问题:这是什么、先看什么、怎么开始。

1. 适合谁先看

  • 第一次接手本仓库的维护者
  • 需要在业务项目里使用软件工厂流程的协作者
  • 想快速理解文档结构、命令入口和协作边界的开发者

2. 推荐阅读顺序

  1. 项目概览
  2. 快速开始
  3. 文档地图

3. 阅读完成后的预期

读完本目录后,应能知道:

  • 当前仓库是一个 CLI-first 的软件工厂项目
  • 正式人类文档只看 docs/
  • 对外使用说明看用户指南,对内过程资料看项目开发文档(内)