认识达内从这里开始

认真做教育专心促就业

程序员写技术文档都需要注意哪些方面的问题

发布：运城达内教育官网
来源：互联网
时间：2019-08-12 08:16

技术文档是程序员在分享自己的工作经验的时候会经常写的一个东西，而今天我们就一起来了解一下，程序员写技术文档都需要注意哪些方面的问题。

程序员写技术文档都需要注意哪些方面的问题

是什么?

可以是技术的一些简单介绍，或是在什么场景下会遇到这种问题，也可以是为什么要写这篇文章。就像吾辈，基本上每篇文章的正文都会有一个场景段落，用来介绍吾辈为什么写这篇文章，以及对涉及问题的介绍(吐槽#打)。

怎么做?

正确的描述具体如何使用，或是如何使用代码实现功能/修复错误。例如介绍JavaScriptArray的文章，那就需要告诉读者如何使用常见的API，例如forEach,filter,map,reduce这些函数，如何的使用它们，给出一些具体可运行的示例，如果有你觉得读者会难以理解的部分，更应该详细解释，并配上代码示例。

在哪里用?

写作有可能漏掉的部分，但却是重要的。如果文章只是单纯罗列了一堆概念和代码，却不告诉读者在什么场景下才会用到，那么这只会是相当糟糕的文章，还不如去看官方文档(大部分文档都是告诉怎么做而不告诉在哪里用，尤其是某些HTML/CSS书籍，简直是把MDN的文档抄了一遍)，至少还准确一些。排版样式

读者进入网页之后，一眼看到的绝对不是具体的内容，而是网页的排版大致是什么样子的，这点在读者阅读时能够清晰的感受出来。就像人的外貌，在开口前读者便能藉此看出大概(所谓以貌取人)。即便可能在读者继续阅读内容而扭转形象，但更有可能是读者直接点X关闭网页，并且留下了不好的印象。

插图

如果说排版样式是外貌，那图片就像人的衣服一样，能为文章锦上添花。更何况还有一图胜千言的说法，可以避免读者在阅读时感到无聊。像是如果有流程图/原理图/时序图这些，将会显著的提高文章的层次。

错别字

但凡写作，如果有人说自己没写过错别字，吾辈是一个不信的。人非圣贤，孰能无过。写作时出现错别字是很正常的，但由于人类本身的原因，所以想要检查是比较困难的--但并不是毫无办法，我们在文章发布后，在网络上再次查看文章，会比在编辑器中更容易察觉到文章中的问题，这其中当然包含错别字。

【免责声明】：本内容转载于网络，转载目的在于传递信息。文章内容为作者个人意见，本平台对文中陈述、观点保持中立，不对所包含内容的准确性、可靠性与完整性提供形式地保证。请读者仅作参考。

< 上一篇：如何才能在众多java程序员中脱颖而出的方法

下一篇：运城java编程开发建造者模式核心概念分享 >