跳转到内容
mCourse

最小工程结构

你将学会什么

Section titled “你将学会什么”
  • 用四条约定判断一个项目是否“可运行、可维护、可协作”
  • 写出让新人 30 秒看懂的项目入口与 README
  • 说清为什么学生项目不该一开始就用最全的结构

正文

Section titled “正文”

很多学生的项目卡在“环境和结构太复杂”。真正适合学生起步的项目结构，不是最全的 Monorepo，而是最容易被自己看懂的结构。建议从这些最小约定开始：

  • 入口文件说明项目是做什么的
  • README 说明依赖、运行方式和核心文件
  • 所有命令在当前终端可以原样运行
  • 配置差异和临时调试信息及时清理

一个最小项目结构长这样：

course-project/
├── README.md          # 依赖、运行方式、核心文件
├── index.py           # 入口文件：说明项目做什么
├── requirements.txt   # 依赖清单
└── src/
    └── main.py        # 核心逻辑

README 不必长，但至少要回答三个问题：这个项目做什么、怎么跑起来、核心文件在哪。做到这四点，你的项目就已经超过了大多数课程作业的平均可维护性。

动手练

Section titled “动手练”

知识检查

Section titled “知识检查”

先自己回答，再看答案：

  1. 为什么学生项目不建议一开始就用最全的 Monorepo 结构？
  2. README 至少要回答哪三个问题？
  3. “所有命令在当前终端可以原样运行”解决的是什么问题？
参考答案
  1. 结构复杂度会拖慢起步和排错，最全的结构不一定适合一个人维护的小项目。
  2. 这个项目做什么、怎么跑起来、核心文件在哪。
  3. 避免“在别人机器上跑不起来”的环境问题，降低协作与展示门槛。

本节小结

Section titled “本节小结”
  • 起步用最容易被自己看懂的结构，而不是最全的结构
  • 四条约定：入口说明用途、README 说清三问、命令可运行、配置干净
  • 最小结构是后续协作与作品集展示的地基
最小工程结构小测
x
1 / 3

作业项目最适合的 README 目标是什么？