如何做项目归档

背景介绍

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

解决思路及方案

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

环境信息

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

缓存信息

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

输出文档

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

注意

  • 得到环境信息后要及时记录,不用下次再问人
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 219,589评论 6 508
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,615评论 3 396
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 165,933评论 0 356
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,976评论 1 295
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,999评论 6 393
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,775评论 1 307
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,474评论 3 420
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,359评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,854评论 1 317
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 38,007评论 3 338
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,146评论 1 351
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,826评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,484评论 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,029评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,153评论 1 272
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,420评论 3 373
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,107评论 2 356

推荐阅读更多精彩内容

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