编写和评审设计文档时的点

这整整一个月我们都在写文当评审文档,干的挺没劲的,但是里边确实有道道啊,其实说白了,还是工作不用心,学习不认真所导致。

经过这段时间的编写,和两次的评审也得出了些结论:


写作技巧:

1 UML图中有明显的错误。但是我画图的时候体会不到错误。这个需要学习
2 措辞,不能太口语化了
3 使用的专业名字,如果是英文的那么就必须要一致,这里的一致说的是,书写上要一直,意思要需要一致,就算不一致也需要写明理由。appid/Appid/APPID/appIDAppId

4 反复检查用在你的文档中的列举,是否每一个字段都说的清楚,而且你这么做都能解释,让人接受。

5 有些可以列举全的项就不要使用“等”这个词了。

6 编写文档的时候可以适当的将需要重点讲的地方加粗或者有所提示,以便于自己回想起来这块想说明什么。

辩论技巧:

你写在文档中功能只要跟现实不是矛盾,能说的过去,那么就可以作为说辞

你的文章在某一点上存在一些语义模糊,说不清楚时,也可以提出来大家一起讨论,这也是解决尴尬的一个方案。

在辩论前你必须是的你的文档是在很严谨的情况下写的,这样才能理直气壮辩论。

最主要的一点就是,随机应变!

可以讲每个需要将的地方重点讲下,其他不重要的地方可以很粗略的越过,这样就不至于前篇一律这样没有重点的讲下去,而听得人也可以知道你想表达什么意思。



---暂时先写这么写着吧!后面再修改!

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值