文档Kata练习

文档Kata练习

  1. 前言
    

1.1 员工的文档作成能力关系到团队的交流和管理。
1.2 然而现阶段,公司员工的文档能力平均水平普遍比较低:作出的文档,词不达意,语病百出,难以阅读。
1.3 为了弥补个中差距,我们提出一种练习——文档Kata练习。

  1. 介绍
    

1.1 介绍文档Kata练习之前,必须先介绍它的前身——Coding Kata练习
① Kata源于日本柔道( じゅうどう)。一个人如何提高自己的编程技能呢?
所谓业精于勤荒于嬉,想要提高自己的编程技能,就要不断的练习。一部分IT人才,提高自己的编程技能,创立了Coding Kata练习。
② Kata的形式往往是一个有待解决的简单编程问题,比如编写计算拆分某个整数的素数因子等。做kata的目的不是找出解决方法(你已经知道方法了),而是训练你的手指和大脑。
1.2 从Coding Kata练习中,我们有了新的灵感,将这种技术运用到提高文档能力中来,或许也能够起到一定的作用。集体对一个坏文档进行反复指摘和修改,一来可以作为休闲娱乐,而来可以提高文档能力,是百利而无一害的手段。

  1. 实施
    

1.1 首先准备一些坏的文档
① 从网络中收集
② 从工作中收集
1.2 由学员挨个指出坏文档坏在哪里,并且做出修改。
1.3 反复执行1.2步骤,直至文档已经找不出问题来为止。
1.4 总结整个过程,交流心得。
1.5 逐步抽象文档“坏味道”,比如没有标点符号,集腋成裘,公诸于众。

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

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 175,066评论 25 709
  • 1.暗闇より夜魔来たる-1あなたはきっとこんな私をお許しにはならないでしょう…ですが、私はあなたを守る以外の何かを...
    波沙诺瓦阅读 5,909评论 1 2
  • 1.暗闇より夜魔来たる-1あなたはきっとこんな私をお許しにはならないでしょう…ですが、私はあなたを守る以外の何かを...
    波沙诺瓦阅读 8,472评论 0 7
  • 2017.9.2 星期六 晴 晚饭后,感到有些累,就跟儿子打招呼说我想休息一下。 小家伙说:“妈妈,以前都是...
    暖与希望阅读 806评论 0 2
  • 落瑛似红心,片片皆有情 零落芬芳醉,犹得双凤飞 ——猫二
    猫二君阅读 962评论 0 0