如何编写好一篇公司文档

在公司里面,如果需要你去编写一篇公司的文档,你会怎么写?

写好一篇文档,你得先搞清楚,你写文档的目的,你写给谁看。

如果文档是作为教程指引,如上图所示。

那么你写文档的出发点应该紧扣用户视角来写,而不是你自己的视角。

首先,是起标题。

用户是带着问题进来的,所以会最先关注到文档标题。

你的文档标题应该是能让用户一眼就能判断出,这篇文档可以解决他什么问题。

例如,用户带着我不知道怎么移动文档的问题进来,在一看到标题是“如何移动文档”时,立马可以解决他的问题。

其次,是文档内容。

对于教程内容编写,我建议是不要太跳跃。

还是回到刚才我们为什么要写文档这个问题上。

既然文档是给用户看的,那么就应该要考虑到用户的学习成本和理解成本,一切站在用户的视角去做这件事。

文档内容在顶部最好要有一个目录,最为内容的纲要梳理。

然后,根据每个需要操作的步骤,通过标题标记,并针对的做出详细的说明,必要的时候可以提供截图参考。

步骤之间,内容尽量保持连续性,流程条理性要强,从上一步可以顺利过渡到下一步等。

内容的风格尽量简洁,颜色不要超过3种,字体大小要适合舒服,格式让位于内容,去掉那些不必要的眼花缭乱的东西。

最后,是文档分类。

文档的分类要统一,同一个类别的内容尽量目录同级。

其他,由于有些文档系统在每次保存时会有邮件通知到该文档的关注人,所以要么就在保存文档时先确保文档已经编写完毕并且没有明显问题,要么就检查一下有没有“通知关注人”这个开关,先关闭了,因为后续还要不断地编辑补充,保存只是草稿的临时备份等。

以上就是在公司里编写好一篇文档的几点建议,这些细节体现的就是你的职业化程度,可以提高你在公司里的专业认可度。

往期精彩文章:
Hans进化营
瑞言商务演讲(下)
瑞言商务演讲(上)