如何写好技术文章

Posted 2021-03-22 lionelgeng

作为程序员，很多时候面对两难的问题。代码开发阶段，由于项目进度原因，很少人会主动写文档；另一方面，后期维护阶段，或者维护其他人的项目，又会抱怨缺少文档，代码混乱等。

仔细想一下，问题解决的方法其实不难，那就是从自己开始，有意识在平时的工作中写技术文档。在自媒体平台，比如微信公众号上写文章，确实不是一件容易的事情，但是在项目中写

技术文档，相对来说来是比较容易的。因为起码选题，内容不用愁了，且这些文档对遣词造句的要求也不高，重点是把问题背景，技术原理，解决方法，主要问题，下一步工作写清楚就行。

因此，对于程序员来说，写好技术文档，或者说技术文章，就是一件比较重要的事情了。这里推荐一份阮一峰github上针对如何写好技术的文章的一些要求规范，可能会对你有所帮助。

github地址：https://github.com/ruanyf/document-style-guide