文档撰写入门

本文档撰写入门课程强调其重要性和实际应用,旨在帮助初学者理解文档撰写的必要性,包括作为项目经理的责任,文档的决定性与被决定性要素,以及历史演变。文章还探讨了写出好文档的方法,如全心投入、积极沟通,并警告了几大撰写误区,如认为文档撰写低级、参考等于拷贝等。同时,针对可能遇到的问题提供了解决方案,如缺乏相关经验、甲方不满意等。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

文档撰写入门

一、课程定位

(1)、“入门”

(2)、“项目经理”:责任承担与成果归属(有得必有失)

(3)、“实用”

1、学会写文档的必要性和意义。

(1)、写文档>做项目/做技术

(2)、技术人员与客户交流的第一种形式

(3)、获得客户认可的第一道关

(4)、展现才华的第一种手段

(5)、成为项目经理的第一步

二、文档撰写的要素

1、决定性要素

(1)、目的(2)、对象(3)、内容(4)、亮点(5)、技术

2、被决定要素

(1)、形式(2)、篇幅(3)、用语(4)、重点

 

目的与对象决定了被决定的要素。

要与对象来决定文档的撰写方式。

 

三、文档历史

1、  文档撰写的技术与非技术层面

(1)、技术内容

(2)、文档内容

2、半技术层面

(1)、文档形式和格式

(2)、排版和图表美化

3、非技术层面

(1)、与业主沟通

(2)、与项目组成员沟通

五、如何写出好文档

1、当接到一个文档撰写任务

(1)、心——全心投入

(2)、脑——积极思考

(3)、血管——动力十足

2、沟通交流工作超过60%

(1)、时刻保持与甲方沟通,不要怕甲方烦

(2)、与同事沟通

3、遇到困难

(1)、自己一定要保持思路清晰

(2)、如果自己没有办法清晰,一定要有清晰的思路去向甲方询问或和上司讨论。

(3)、一定要有足够的信心和士气

4、平时做好准备——机会总是给有准备的人

(1)、平时开会

(2)、平时自己经手的文档

(3)、同事在做的文档

六文档撰写的几个致命误区

1、  写文档是一个低级的工作

2、  参考=拷贝

3、  认为背景、可行性、必要性、意义、作用都是虚的,技术内容才是实在的

4、  甲方不懂,可以忽悠

5、  写好了第一稿才给甲方看。过程也不交流沟通

6、  有问题不敢问甲方,怕甲方说自己水平低

7、  有问题就去问甲方,但是没有一点准备

 

七、可能会遇到的情况

1、从来没有接触过这方面的内容。(解决最好的方法:沟通)

2、甲方说文档完全不行,觉得我们没花时间

解决:把一定是对的找出来,要有信心,去说服别人,不对的地方,虚心讨教

3、甲方对我们印象很差,觉得我们没有能力

4、中途接手一个文档撰写任务

5、同事交出来的文档思路不正确

解决办法:复述一遍

6、没有做好足够的准备,进度跟不上

解决办法:不怕麻烦,及时沟通

7、连续很多天通宵,看到文档就头痛

解决:冷静下来,理清大思路

8、  甲方说文档不行,但他们也不知道如何写

解决:引导他怎么理清思路,给他各种建议。

9、  甲方内部意见不统一,不知道听谁的

解决:(1)、与谁说的了话那个为主。(2)、在他们在一起的时候再讨论。(3)、做好一份修改可以同时发送给他们,他们看了可以先内部讨论一下。

 

 

扩展:积累一些好的技术文档

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值