摘要:
写文档的困惑写文档不像写代码,它没有明确的好与坏,更没有明显的正确与不正确。也正因为此,对于写惯了代码的程序员来说,写文档是无比痛苦的,完全找不着北。写短了,人家说没写清楚,太不详细;写得长了,人家说太琐碎,那么长,哪有精力看。领导说,“这个问题简单,两三页随便描述一下就行了。”你若真是只写个两三页,百分之百挨批。又要言简意赅,又要表述详尽。这比写代码要费劲多了。我们写代码时,讲什么重构呀重构,有几个人写完代码重构的?没几个吧。有哪一个写完程序重构个十来回的?亘古少有吧。而写文档,随便一个文档,被重构个十来回、几十回,甚至推倒重来个几回都很正常。写代码与写文档,完全是两个境界。要不怎么说,写代 阅读全文