应该注重易读、完整、安全、统一、可追溯及继承。
易读：版本管理可能会设计接触源代码的各部门各岗位，人员水平参差不齐。应该采用清晰、明确、规范的语言撰写，避免模棱两可产生歧义的术语。
完整：除了自行编写的代码，开发中势必会引入各种第三方库。虽然他们都有较为完整的使用文档，但还是建议把有所涉及的部分结合实际开发环境注释在文档中。也可以减少寻找对应资料所浪费的时间。
安全：文档的安全性，是指明确参与文档最终修订的人员，也就是动笔的人权责要清晰，不要谁有个变动调整都去修改。另外如果涉及到机密，也可以为文档设置密码，分发在保存人手中，一人一密码。
统一：版本控制要的就是代码的统一性。文档也一样。可以通过git或svn来管理文档，任何新的修改都要从统一的源头拉取版本。也能避免冲突。
可追溯及继承：每次更新都要有明确的记录（修改）人，为日后可能出现的问题及时定位。
大致可以采用以下设问结构来回答：
B（较新）版本比A（较旧）版本，对哪些模块做了怎样的（增加/删除/修改）改动，达到了怎样的效果。代码位置位于……（路径，区间）。（如有）第三方库或控件等，所涉及的功能说明部分是……日期，参与人，负责人，修订人
网友评论