• [个人] 如何编写更好的文档 2020-12-26 19:48:34

    好文档的秘诀就是在你写代码的时候就把它写出来。你是你的第一个听众。向自己解释你在做什么。未来的你会感谢你自己! 这里有三个具体步骤,你可以趁早写好文档。   1. 从准确的笔记开始 当你在代码中提出想法时,通过从准确的笔记开始,确保你不会很快忘记重要的细节。虽然你以后会想用长篇的形式向自己解释一些事情,但短篇的笔记就足以捕捉细节,而不会打断你的编码会话流程。 在你的代码旁边打开一个文档,写下你使用的命令、决定和来源等内容。这可以包括 你输入的终端命令 为什么您选择了一种特