最近涉及到项目交付,编写了很多技术文档,但因为没有经验导致多次修改,尤其是客户和我们技术人员的关注点其实是不一样的,就导致我没有抓住重点,导致反复修改,这里总结下我的一些经验。
文档与技术协议合同对应
就我所经历的项目,前期的技术要求和最后的项目有一些细节的偏差。最后交付文档的时候更多应该以技术协议和合同为准。并且需要突出体现里面的内容。
注意题名一致
项目名称与文档名称必须前后一致,不能多,不能少,不然会产生歧义。
注意时间一致
注意前后文时间一致,包括封面的版本,签字页版本,修订记录的版本,其中修订记录注意最后编撰人和修改时间。
注意文档时间线
文档应当按照计划,方案,设计,测试,报告的顺序依次编写,注意每个时间节点对文档时间的限制作用。
部分问题不好总结,不过待补充了,