返回

技术写作的错误思想,你中招了吗?

闲谈

程序员的写作课:一、关于技术写作的那些错误思想

技术写作似乎一直是程序员的眼中钉,提到写作,程序员第一反应就是:“不会写”,“太难写了”。因此很多程序员宁愿写文档,写方案,也不愿意写文章。

其实,写作是属于我们向世界表达看法的工具,它属于每一个人。你写一句话也是写作;你写一段话也是写作;当你开始写的时候,那无论你写的是什么,只要你将其展现出来,这便是写作。

作为一个程序员,在写代码的时候,你写的代码便是文章,你写的注释便是文章。只是你之前没有意识到而已。

一个真正的程序员,无论他是否愿意承认,他都有着很强的写作能力。他在码代码的时候,在思考的时候,都会或多或少的形成一些思想,而这些思想,都可以通过文字表达出来。

所以,程序员不是不能写文章,而是他们不想写文章。或者说,他们还没有意识到自己有很强的写作能力。

当然,技术写作和写文章是有区别的,但这种区别只是在于专业性不同,写作的形式不同,内容的要求不同而已。从本质上来说,技术写作也是写作的一种。

所以,如果你是一个程序员,不要再给自己找借口了,不要再给自己贴上“不会写文章”的标签了。其实,你比你想象中更有才华,你比你想象中更有能力写出好的文章。

下面,我们就一起来聊一聊关于技术写作的那些错误思想。

1. 技术写作是枯燥无味的

技术写作并不是枯燥无味的,它只是需要你用一种更专业,更严谨的方式来表达你的思想。如果你能写出好的代码,那你一定也能写出好的文章。

2. 技术写作很难

技术写作并不难,它只是需要你有一定的技术背景。如果你是一个程序员,那你一定具备了这个背景。你需要做的只是将你的技术知识转化为文字。

3. 技术写作没有用

技术写作是有用的,它可以帮助你向他人传达你的技术思想,可以帮助你解决问题,可以帮助你推广你的技术产品。

4. 技术写作不需要创新

技术写作也需要创新,你需要用一种新的,独特的方式来表达你的技术思想。你需要打破传统的写作模式,你需要找到属于你自己的写作风格。

5. 技术写作不需要情感

技术写作也需要情感,你需要用你的情感来打动你的读者。你需要让你的读者感受到你的热情,感受到你的喜怒哀乐。

以上便是关于技术写作的五个错误思想,希望你能抛弃这些错误思想,重新认识技术写作。

现在,你已经对技术写作有了一个新的认识,那么,让我们开始我们的技术写作之旅吧!

补充

在正式开始我们的课程内容之前,我们先来聊一聊技术写作的三个原则:

  1. 准确性 :技术写作必须准确无误,不能有任何错误。
  2. 清晰性 :技术写作必须清晰易懂,不能有任何歧义。
  3. 简洁性 :技术写作必须简洁明了,不能有任何冗余。

这三个原则可以说是技术写作的灵魂,如果你能做到这三点,那你一定能写出好的技术文章。

除了这三个原则之外,技术写作还有很多需要注意的地方,比如:

  • 逻辑性 :技术写作必须有严密的逻辑性,不能前言不搭后语。
  • 结构性 :技术写作必须有清晰的结构,不能杂乱无章。
  • 可读性 :技术写作必须具有良好的可读性,不能让读者读起来费劲。

这些都是技术写作中需要考虑的问题,如果你能把这些问题都考虑清楚,那你一定能写出好的技术文章。

最后,再给大家一个建议:如果你想写好技术文章,那就多读多写。读别人的文章,学习别人的写作技巧;写自己的文章,锻炼自己的写作能力。只要你坚持下去,你一定能成为一个优秀的技术写手。