保持简单,每个想要描述的元素都只给一小段,如果对读者有帮助的话,还可以包含图表。举个例子,一个高层次的UML类或序列图有助于解释内部定制框架如何工作。抵挡住包含所有细节的诱惑,不要觉得你的图表需要展示一切。我喜欢花上几分钟时间勾画一个展示了选定(重要)属性和方法的高层次的UML类图,而不是使用UML工具或IDE插件从你的代码库自动生成的复杂图。任何图都保持在一个较高层次的细节意味着着它们能在更长时间内较少变动,保持最新,因为它们能够忍受代码的微小变化而仍然有效。