0x01 上传文件到svn目录中
每个项目都有一个文档svn文件,用于交换项目相关文档。例如echo项目的文档svn文件名为。这个svn根目录下有一个目录(若不存在则创建)。离职人员需要在该目录中创建以自己名字命名的目录,并将文档上传到该目录中。例如某位名为的学生即将离职,则上传文档后的基本目录结构应如下:
echo_document/handover/lixianmin/project1/*.* /other-project-documents
0x02 交接文件原则
交接文件需要条款明确,让双方满意,相关建议原则如下:
路径清晰:在后续工作中,当接班人发现相关问题时,可以按照图谱逐项检查,可以快速确定问题相关的资源、代码和人员,进而决定解决方案。 链接丰富:附上尽可能多的相关文档,让你的交接文档成为你交接工作的索引文档。 有明确的接班人:一定要有明确的接班人,即使没有合适的,也要指定一个,哪怕是你的领导。 抄送领导:这可能是最重要的一步。 验收评估:不管是接班人还是领导,都要对你的交接文档进行验收和评估。反馈表示交接完成。注意不是验收签字,而是验收评估。只有评估之后,才说明对方真的读了你的文档。否则可能只是草草收下,对方根本不知道你写了什么。 0x03 交接文档模板
它是一个以.md或.docx为文件名的文档,用于描述项目需求的主要相关内容。每个项目至少需要包含一份交接文档。
对于每个完整的项目要求,给出:
架构设计说明及设计思路(图片或文字均可); 关键代码目录,以及主要代码文件的功能描述及职责划分; 相关协议的功能描述; 配置格式、位置、配置项的功能描述。
对继任者的建议
成功经验分享:附相关文档链接。失败经验分享:当前代码的设计缺陷,陷阱及防范清单,未来预期改进及原因,附相关文档链接。继任者需要学习的技能教程或建议,附相关文档链接。其他注意事项,与继任者沟通后补充。
继任者未来要做的工作
具体项目任务列表,按重要性排序。未完成需求的详细描述,包括相关内容和进一步开发计划的演进方向。相关联系人(包括策划、其他程序员、UI、美工等),其职责列表。如果你正在接手其他程序员的工作,请附上他们之前写的交接文档等其他信息。
将文件和物品送达接收人
电子版账号密码清单,包括但不限于git、svn、测试账号、URL地址等。电子版资料统一上传至公司服务器并附上链接。如有重要纸质文件,除交接纸质文件外,还需将文件图片扫描上传并附上链接。电脑按公司流程交接,其他硬件如测试机或外设等交接给相关人员并签字(参考第8项:交接验收)。
常见问题及解决方案
问题1:找不到某个文件?建议先联系XXX同事。如果不行,再联系XXX... 问题2:如何操作某个具体项目?建议联系XXX同事,他之前操作过... 问题3:...
软件描述
软件清单,包括软件名称、版本、SDK使用说明等。自编的小工具程序(含exe及各类脚本)均标注了源代码地址,并附带了功能及操作说明。