0x01 上传至文档svn中的handover目录

每一个项目都有文档svn，用于交流项目相关的文档，比如echo项目的文档svn的名称为echo_document。这个svn根目录下有一个handover目录（如果没有则创建），相关人员需要在handover目录中创建一个以自己姓名为名字的目录，将相关的文档资料上传到该目录下。比如，假定一个名为lixianmin的同学在写总结文档，则上传后的基本目录结构应该是如下样子：

echo_document/handover/lixianmin/project1/*.*
             /other-project-documents

0x02 总结文档原则

总结文档需要条款清晰，建议原则如下：

1. 路径清晰：在后续工作中，后续接手人发现相关问题时可以按图索骥、逐项检查，能很快的确定问题相关的资源、代码和人，然后决定解决办法。
2. 链接丰富：尽可能将相关的文档都附上去，让你的总结文档成为工作索引文档。
3. 抄送领导：这个可能是最重要的步骤。

0x03 总结文档模板

是一个名为summary.md/summary.docx的文档，用于说明项目相关内容，要求每一个项目至少包含一份这样的总结文档。

1. 对每一份完整的项目需求，给出：

   1. 构架设计说明和设计思路（可图可文）。
   2. 关键代码目录，以及主要代码文件的功能说明、职责划分。
   3. 相关协议的功能说明。
   4. 配置的格式、位置，配置项的功能性描述。

2. 工作建议

   1. 成功经验：附加相关文档链接。
   2. 失败经验：当前代码的设计缺陷，容易出错的坑及预防清单，未来预计可改进的点及原因，附相关文档链接。

3. 账号、文件与物品交付

   1. 电子账户密码清单，包含但不限于git、svn、teambition、testin测试账号、URL网址等。
   2. 电子资料统一上传公司服务器，附链接。
   3. 如果有重要的纸质文档，需扫描并上传文档图片，附链接。

4. 软件说明

   1. 含软件清单、版本、plugins、SDK等使用情况描述。
   2. 自己写的小工具程序（含exe和各类脚本）标注源代码的地址，并附功能和操作说明。

0x04 文档目录说明

每一个项目都需要有一个单独的目录存放相关文档，整个总结文档目录结构参考如下：

1. project1/
   • summary.md，本项目的交接文档，具体模板格式请参考条目 《0x03 总结文档模板》
   • documents/*.*，自己写过的与项目相关的文档
2. project2/
   • ... (参考project1)
   • ...
3. other-documents/ （公司任职期间写过的跟具体项目无关的其它文档）