对于初学者文档应该怎么编写呢?使用什么模板或格式?
本文發佈於4218天前,文中的資訊可能已有所發展或是改變,請謹慎使用!
在一个项目从开始提出需求到实施结束,这个过程会涉及很多文档的编写,在编写的过程中,对于初学者来说并不好把握,常常会不知道使用什么格式、排版,内容要怎么来写。
一般来说通用的模板内容大都内容全面、详细,比较复杂,初学者没有经验写起来会比较吃力。所以编写时可以使用通用模板进行模仿,但不用全部照搬。
实际上编写文档就像写作文,只要条理清晰的讲述出相关内容,突出重点,不要偏离该文档主题就可以了。当然如果能详细的将5个W2H原则说明清楚,再配上相应图例(流程图),那就更好了。
5个W2H原则说明:
- WHY ——为什么?为什么要这么做?理由何在?原因是什么?
- WHAT——是什么?目的是什么?做什么工作?
- WHERE——何处?在哪里做?从哪里入手?
- WHEN——何时?什么时间完成?什么时机最适宜?
- WHO——谁?由谁来承担?谁来完成?谁负责?
- HOW——怎么做?如何提高效率?如何实施?方法怎样?
- HOW MUCH——多少?做到什么程度?需要多少时间?数量如何?质量水平如何?费用产出如何?
暂无标签