交接文档规范

238

交接文档规范

1、上传至gitlab中

所有交接人提交的文档放在gitlab handover这个组内,每个交接人都有一个自己姓名命名的gitlab项目地址,交接人员需要在自己姓名命名的gitlab项目地址中创建一个以自己姓名为名字的目录(张三:zhangsan)

这样设计的好处是文档清单、密码清单权限可控。

举个例子:上虞政协项目无纸化,张三交接

#gitlab组
/handover
	#交接人(gitlab对应的项目地址)
	./zhangsan
		#对公司、项目、管理、执行、技术等各方面的建议或意见,非必需
		./suggestions/*.*
		#公司任职期间写过的跟具体项目无关的其它文档,非必需
		./other-documents/*.*
		#所属项目中文名称1
		./上虞XXXX
			#交接文档,markdown或者word文档,必须有
			./handover.md
			#交接文档相关资料,必须有
			./documents/*.*
		#所属项目中文名称2
		./杭州XXXXX
			#交接文档,markdown或者word文档,必须有
			./handover.docx
			#交接文档相关资料,必须有
			./documents/*.*

2、交接文档原则

交接文档需要条款清晰,双方满意,相关的建议原则如下:

  1. 路径清晰:在后续工作中,接手人发现相关问题时可以按图索骥、逐项检查,能很快的确定问题相关的资源、代码和人,然后决定解决办法。
  2. 链接丰富:尽可能将相关的文档都附上去,让你的交接文档成为你交接工作的索引文档。
  3. 明确接手人:一定要有明确的接手人,即使没有合适的也要指定一个。
  4. 抄送领导:组长和项目经理
  5. 验收评价:无论接手人或者领导,都要验收评价你的交接文档,有反馈才标志着交接完成。注意,不是验收签字,而是验收评价,只有评价过了,才意味着对方真的看了你的文档,否则可能只是草草接收,其实对方并不清楚你写了啥。

3、交接文档模板

交接文档是一个命名为handover.md或handover.docx的文档,用于说明项目需求的主要相关内容,要求每一个项目至少包含一份交接文档。

  1. 对每一份完整的项目需求,给出:

    • 项目中文名称和概括
    • 需求的详细描述
    • 构架设计说明和设计思路(可图可文)。
    • 关键代码目录,以及主要代码文件的功能说明、职责划分。
    • 相关协议的功能说明
    • 配置的格式、位置,配置项的功能性描述。
  2. 接手人工作建议

    • 成功经验传授:附加相关文档链接
    • 失败经验传授:当前代码的设计缺陷,有哪些容易出错的坑及预防清单,未来可以预计改进的点及原因
    • 接手人需要学习技能教程或建议:可附相关文档链接
  3. 接手人未来需要做的工作

    • 具体项目工作清单,按重要程度排序。
    • 未完成需求的详细说明,包含进一步的开发计划中相关内容及演变方向的说明。
    • 相关联系人(含策划、其它程序、UI、美术人员等),他们负责内容的清单。如果是接手了以前其它程序人员的工作,则把他以前写的交接文档等其它信息也包含进来。
  4. 接手人文件与物品交付

    • 电子账户密码清单,包含但不限于git、svn、database、redis、vpn、 mail、url、api等。

      类型地址账号密码备注
      gitssh://git@xxxxx/xx/xxx-app.gitzhangsanzhangsan版本控制
      mysql192.168.10.31dddddddddd数据库
      mailmail.xxx.com.cnvvvvvvvv邮箱
      vpnxxx.fff.10.22ddddddddddvpn
      urlhttps://xxx.gov.cn/xxxxxxxx生产环境前端
      urlhttps://xxx.gov.cn/apixxxxxxxx生产环境后端
      urlhttp://xxx.10.92:8080/xxxxxxxx测试环境
    • 电子资料统一上传公司服务器,附链接。

    • 如果有重要的纸质文档,除交接这些纸质文档外,另需扫描并上传文档图片,附链接。

    • 电脑按公司流程交接,其它硬件,比如测试机或外设,移交相关人员并签字。

  5. 常见问题及应对方案

    • 问题一:具体项目如何操作?建议可找 XXX 同事,她之前操作过……
    • 问题二:无法找到某个文件?建议可先找 XXX 同事,如不能再找 XXX……
    • 问题三:......
  6. 软件说明

    • 软件清单,含软件名、版本、plugins、SDK、library使用情况描述等。
    • 自己写的小工具程序(含exe、各类脚本、插件等)标注源代码的地址,并附功能和操作说明。
  7. 后续联系方式

    • 手机:137xxxxxxxx
    • 邮箱:xxxx.outlook.com
    • 微信:xxxxxxx
  8. 交接验收清单

    项目接手人签名验收日期验收评价结果
    YYXX李四2021.12.24文档齐全,交接方便同意
    温州XX李四2021.12.24文档齐全,交接方便同意