如何做项目归档

背景介绍

在日常的工作当中,会接触到多个项目,项目从接触到熟悉,要有一个过程,当一个阶段结束后有一段时间不会去接触。等下次再开发或者维护时,往往需要再次熟悉,这比较费时间。所以我希望找到一个方法,减少这段时间,使得能立刻熟悉很久没动的项目。

解决思路及方案

熟悉一个新项目的过程,实际上会产生很多中间产物,或者说“缓存”,有了“缓存”,可以进一步做开发。
可以把“缓存”输出为文档保存下来,下次再看这些文档就可以了。

环境信息

  • 代码存放地点。例如TFS地址,TFS账号密码等。
  • 相关的服务器,服务器名字、登录账号
  • 数据库地址,账号,数据库名,相关表名
  • 程序客户端,或网站页面入口
  • 项目背景,项目目的
  • 其他的链接等信息

缓存信息

把一些处理的中间结果保存起来,便于再次开发时使用。
例如画的流程图的草图,表格等。
统一放在一个缓存的文件夹中

输出文档

  • 源码
  • 系统截图
  • 需求文档
  • 设计文档
  • 实现文档
  • 用户手册
  • 部署文档
  • 测试文档(如UAT)
  • 维护记录
  • 数据库关系图(join关系)
  • 字典表

注意

  • 得到环境信息后要及时记录,不用下次再问人
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 175,261评论 25 709
  • 发现 关注 消息 iOS 第三方库、插件、知名博客总结 作者大灰狼的小绵羊哥哥关注 2017.06.26 09:4...
    肇东周阅读 14,196评论 4 61
  • 作者/Author:苏近之 地点/Address:浙江省杭州市植物园附近 时间/Time:2016年04月30日 ...
    IYANYU阅读 1,813评论 0 0
  • 1.可以看出这张照片有点曝光了,人物比较暗,后面的景较亮,首先把原图复制一份,打开复制的图层。 2.在上方选框中选...
    奋斗的核桃阅读 2,206评论 0 0
  • 题记:找到个能写日记的地方。 亲爱的日记,我今天过地还是跟昨天差不多,昨天过地还是跟前天差不多,至于前天过...
    排造胚阅读 2,224评论 0 0