编程语言应用

首页 » 常识 » 问答 » 如何写出高质量文档百家号百度经验
TUhjnbcbe - 2023/9/15 20:51:00
我是一个工作了一年的程序员,我知道对于软件相关行业来说,会写代码不是什么本事,因为每个人都会写,然而你想在这个领域走得很高很远,没有个很多年的经验是不可能的事情,我不相信每个人都是天才。作为一个程序员,与编程一样重要的事情是什么呢?那就是会写一些高质量的文档。首先,我们应该改变一种思维,对于文档的一种思维。大多数人都认为,文档只是为程序服务的文字形式而已。但是我这里想说的是,我们不但要会变成编得很牛,而且还要会写很有质量的文档。我们必须把文档提升到和代码一样的高度。因为,只有好的文档,别人才能更好的看懂你代码所要表达的意思。或许很多人都不懂代码,但是看了你的文档,他就很明确的知道了你所要表达的意思,知道你产品所要展示出来的东西。我们在编写邮件的时候,必须把自己所要表达的东西高效的写出来,不要模棱两可。在还没有发送邮件之前,我们很有必要查看一遍邮件的内容,看看里面的内容是否完整,是不是有很多错别字,语言表达是不是通畅,有没有表达不清楚的地方。当你的邮件发送出去的时候,再后悔里面的内容就已经来不及了。如果你编写的是一个项目文档,那么我们就应该严格的按照项目组组长的特定的模板来编写,不要异想天开的发挥自己的聪明才智,那样只会弄巧成拙。写完文档之后,不要吝惜那么一点点时间,我们有必要对文档的完整和语法进行检查和修改。当然如果有兴趣,在下班时间,我们可以读一些能够提高自我修养,能够提高自我语言表达能力和写作能力的书籍或文章,看一下别人是怎样表达自己思想的。
1
查看完整版本: 如何写出高质量文档百家号百度经验