美文网首页
小谈写文档

小谈写文档

作者: 单行者 | 来源:发表于2019-03-14 22:11 被阅读0次

一同事写完文档让我帮他把把关,我大概浏览了一下他的文档,内容都有,但很干涩,很突兀。像一堆好东西,没有顺序,没有分类,杂乱地堆放在一起。整体感觉文档好像是写给他自己看的,不是用来交流传递信息的。

文档应该是用来记录和传递信息的,如果写下来的东西别人看得迷糊,或者以后连自己也看不懂想不起来,那这个文档,它的价值,就打折扣了。我们写文档,就像选用上乘的玉石雕琢一个精美的艺术品,像用优质上等的食材烹调一桌丰盛美味的佳肴,需要用心细细打啄和选配。

如果不会选择搭配,再精美的材料也是一种浪费。

文档也是一样,文档当然需要有有价值有含金量的内容,但是也需要巧妙的组织,圆润的过渡,符合思维的表达陈述。

这样的文档才让人易懂爱看。

相关文章

  • 小谈写文档

    一同事写完文档让我帮他把把关,我大概浏览了一下他的文档,内容都有,但很干涩,很突兀。像一堆好东西,没有顺序,没有分...

  • 心中无尘,码字入神

    一直以来,由于工作需要都在用word写文档:开发指南、软件需求、投标技术文档等。这些文档,有大有小,小的例如部署方...

  • 小神来谈写玄幻

    第一:写出爽点。比如装逼打脸(主角由受人鄙视到受人尊重),扮猪吃虎(隐藏实力到爆发实力),疯狂升级(一步步升级,升...

  • 我与小说之事

    我 与 小 说 之 事 白 冰 让我谈写小说之事,其实,写...

  • swagger(接口开发工具)介绍

    翻译 从写文档开始说起 后台同事小波写了一堆 RESTful接口,作为一个前端开发,我让他给我写一个API文档,大...

  • Angular4-学习笔记-1-迈出第一步

    学习资料来自 Angular.cn 与 Angular.io。虽然官方文档很全面,但小镭觉得官方文档写的很杂乱,重...

  • 关于写文档

    工作上被安排了一个活儿,写投标文件。如同噩梦一般,但又带有一点点期待。 噩梦是什么呢? 我不会写呀!以前写过软件设...

  • 为什么开发人员都不愿写 API 文档?

    程序员最讨厌的两件事:1. 写文档,2. 别人不写文档。大多数开发人员不愿意写 API 文档的原因:写文档短期收益...

  • 技术文档 | 文档对项目的重要性

    项目文档的分类 项目文档的重要性 常见的误区 写文档是浪费时间?没时间写文档?文档本身也是产出:coding的时间...

  • ES集群中文档读写原理

    一、文档写原理 二、文档读原理

网友评论

      本文标题:小谈写文档

      本文链接:https://www.haomeiwen.com/subject/dbmhmqtx.html