这两天写文档的一点感受

到公司两天了,一直都在写一个文档。我平时并不怎么注意写文档,偶尔写写也只是事后总结,正儿八经的项目文档这还是破天荒头一遭。

说来挺惭愧,就这么两三页的文档,我写了两天,改了两次,这已经是第三次写,至于通不通的过目前还不知道。两次被卡给我的教训不少,值得好好检讨一下。

第一天到公司,正赶上公司开始数据库建模,因为项目组只我一个人用过PowerDesigner,所以经理让我写一份关于《如何建立CDM》的文档。其实我也只是偶尔用PD做做OOM,CDM从主管嘴里说出来之前我是闻所未闻,没办法了,谁让咱大话说到前面了,硬着头皮也要顶。

还好建立CDM并不是很难,看了看帮助文档,做了一个example,倒也有了些眉目,于是根据自已对CDM的理解,写了个流程文档。就和昨天我发那个用PowerDesigner进行概念数据建模(初体验)差不多。

结果文档到主管那,卡了!主管说,域和继承项目中用不到,删!我心想就算用不到放在文档里大家当学习和参考资料也不错嘛,当然嘴上没敢说。唉,删就删吧。于是重做了example,这次又加了图示,同时加上了一些概念的解释,并通过CDM生成PDM后的对照来说明之间的关系。就这样删了一部分却加入了更多。

第二次将文档check in到VSS上,不一会主管又把我叫了去,问我role name做什么用?(因为我的图示上此项有填写内容)我说是角色名,可有可无,主管大笔一挥说,“图表中不能有中文,这个功能你把它从图表中拿掉,以免误导其它人。还有PDM图等与建立CDM无关的也删掉”。这时我才恍然大悟,原来主管让我写的是一个建立CDM的规范化文档,既然是规范性的东东,表述自然得准确、明了。唉,又失败了.......

反省两次的失败教训,检讨了一下,总结为以下几点:

1.缺少CDM建模经验,以至于在写文档时没有重点,没有根据项目需求做出取舍。

2.没有理解主管的意图就勿忙下手。犯了需求分析不充分的错误。

第三次写文档,我删了大部分解释性的东西,对于建立CDM的流程更加细化和准确,对于重点、易错的部分做出提示。我想这次总不会再被卡了吧......

评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值