如何编写好一篇公司文档

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

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

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

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

首先,是起标题。

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

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

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

其次,是文档内容。

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

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

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

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

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

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

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

最后,是文档分类。

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

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

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

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

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 205,236评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,867评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,715评论 0 340
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,899评论 1 278
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,895评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,733评论 1 283
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,085评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,722评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,025评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,696评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,816评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,447评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,057评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,009评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,254评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,204评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,561评论 2 343