文档结构:标题与列表
你将学会什么
Section titled “你将学会什么”- 说清文档为什么影响别人对项目的评价
- 用「全篇一个 # + ##/###」组织信息层级
- 用「每项只说一件事」的短列表代替长段落
很多学生把文档当成「写完代码后的补丁」,但实际上文档常常决定别人怎么评价你的项目。课程作业里,老师不一定有时间仔细看每一行实现,但通常会快速扫一遍:这个项目解决了什么问题、我怎么运行它、我该看哪些文件。如果你能在三分钟内让读者建立正确预期,你的项目就已经赢了一半。
Markdown 的标题不是「越大越重要」,而是代表信息层级。建议你先建立这套最小层级:
#:页面或文档标题##:一级章节###:二级小节####:补充说明或边界条件
常见问题是:一篇文档里 # 用得太多,导致读者看不出主次。更实用的写法是:整个文档只保留一个 #,其余都用 ## 和 ### 组织。
学生项目里最常见的说明结构其实是列表,而不是长段落。最小可用的原则是:
- 每项只说一件事
- 每项长度尽量接近
- 列表项不超过 7 个,否则拆成小节
如果你发现自己在写很长的无序列表,通常意味着应该加小节标题,而不是继续堆 bullet。
先自己回答,再看答案:
- 标题里的
#和##有什么区别? - 为什么一篇文档不要用多个
#? - 列表项超过 7 条时应该怎么做?
参考答案
#表示页面或文档标题,##表示一级章节,数字越小层级越高。- 多个顶级标题会让读者看不出主次,全篇保留一个
#信息层级更清楚。 - 应该拆成多个小节,而不是继续堆 bullet,否则列表难以扫描。
- 文档决定别人 30 秒内对项目的判断
- 全篇一个
#,其余用##/###组织 - 列表每项只说一件事,超过 7 项拆小节