⚠️ 文档最主要解决什么
给一个项目写文档,最主要是为了【0】。
开始练习 →
文档主要写给谁
一堆文件,该从哪个开始? 没说明 有说明 项目文档的读者是【0】。
开始练习 →
⚠️ 代码写得够清楚就不用文档了吗
一堆文件,该从哪个开始? 没说明 有说明 "好代码自解释,不需要文档"这个说法【0】。
开始练习 →
什么样的文档最没用
一堆文件,该从哪个开始? 没说明 有说明 下面最没用、甚至有害的文档是【0】。
开始练习 →
文档该放在哪儿
一堆文件,该从哪个开始? 没说明 有说明 项目文档最该放的位置是【0】。
开始练习 →
这份 README 缺几节
一堆文件,该从哪个开始? 没说明 有说明 一个项目的 README 长这样: # calc ## 是什么 一个命令行计算器。 ## 怎么装 git clone https://example.com/calc.git cd calc p
开始练习 →
README 第一句该说什么
README 开头第一句最该说清的是【0】。
开始练习 →
"为什么"这一节在回答什么
README 里的"为什么"一节,是在告诉读者【0】。
开始练习 →
⚠️ "怎么跑"和"怎么装"该分开吗
安装步骤和运行步骤【0】。
开始练习 →
"怎么测"那一节对读者有什么用
README 写清"怎么跑测试",对读者的价值是【0】。
开始练习 →