一份真正有用的 README,应该先回答什么
先让读者知道项目解决什么问题,再告诉他怎样完成第一次运行。
关于工具、表达和学习方法的短记录。每篇从一个具体问题开始。
先让读者知道项目解决什么问题,再告诉他怎样完成第一次运行。
标签的意义,往往比页面最初的视觉效果更耐用。
从内容需要多少空间出发,让网格自然适应屏幕。
先记录问题与结论,再决定是否需要更复杂的笔记结构。
一次提交最好能够用一句具体的话说明它改变了什么。
格式合法、结构符合预期、字段含义正确,是三个不同的问题。
编码、引号和列的含义,决定了表格能否被可靠交换。
先看状态、响应头和耗时,再决定是否需要深入抓包。
把“感觉慢”转成可观察的 CPU、内存、磁盘和服务状态。
找到匹配行只是开始,理解文件位置和周围内容同样重要。
收藏条目、阅读标注和形成判断,可以分成三个小步骤。
先确定想完成的任务,再选择合适的章节和练习。
一张图不必回答所有问题,先决定它最重要的比较关系。
有限的字号、清楚的间距,比不断增加样式更容易维护。
一个小而完整的复现过程,可以节省来回沟通的时间。
保留访问理由,让收藏成为下一次工作的入口。