日照网站建设公司告诉你什么是文档中心

日照网站建设公司告诉你什么是文档中心

何为文档

文档是系统设计的蓝图。没有文档，我们将难免重复解决已经解决过的问题，而且花大量时间查看代码来寻找简单的答案。没有文档，我们的新员工只能对着系统抓耳挠腮，并怀疑在这种系统中怎么可能完成自己的任务。

回顾一下目前为止我们设计过的所有架构，如果不花同等的时间来讲一下写文档的方法，那简直是一种罪过。写文档是开发工作的一部分，而不是等重要工作完成后才开始的事情。就像需要重构的臃肿代码、需要自动化的低效率流程，或者没有被测试覆盖到的函数一样，略过文档也会欠下技术债。

不要以为文档只是简单地写下代码如何工作。的确，我们需要在开发流程中预留出写文档的时间，用于记录我们开发的代码是如何工作的，但是写文档远远不止为每一行代码写一段描述。

文档有多种形式，而其中很多只有在架构支持时才能成型。虽然有些文档只是用于描述每个函数的普通文本，但这种文档背后往往有一套基于搜索、导航和视觉呈现的构建系统。其他的文档用于展示系统的资源，由我们所写的样式、脚本、模板和模式来驱动。

静态文档

Hologram是基于 Ruby 的通用文档工具，你可以在代码库中写小段的注释，然后通过它来收集这些注释生成的静态页面。这些 Markdown 格式的文档块可以放进你的 Sass、CSS 或者 JavaScript 文件中。这些文档块还包括用于描述页面名称和导航等相关信息的元数据，并且它的书写形式完全自由。Hologram 让你可以将文档内联地写在代码中，这有助于使文档保持近时间建立，同时使开发人员总能看到这些文档。

SassDoc是基于 Node 的系统文档工具，它宣称“SassDoc 对于 Sass 的意义，就像 JSDoc 对于 JavaScript 的意义一样”，而且它的确如此！ SassDoc 与 Hologram 有点像，它也依赖于代码中内联的注释来生成文档。然而，Hologram 是通用的、多功能的工具，SaasDoc 却专注于描述 Sass 变量、函数、混入（mixin），以及它们是如何相互影响和依赖的。如果你正在构建一个大型的 Sass 框架，或者一个复杂的栅格或颜色系统，SassDoc 正是你想要的工具。

代码驱动的文档

Pattern Lab 是多平台模式库工具，它使你可以模块化地开发设计系统，并将模板和 CSS 转换成可浏览的模式库。在模块化的系统中，你可以先开发每个单独的模式片段，然后通过组合这些片段产生更复杂的模式。Pattern Lab 提供了一个基本框架，用于模块化地创建并组合这些片段，使之成为更复杂的模式，甚至还能输出完整的页面。可预览的组件库是开发者、设计师、用户体验师、质量工程师和产品所有者聚在一起时可以使用的很好工具。它为设计系统中的每个部分创建了一门通用的语言和稳定的参照系。

JSON 模式是用于描述数据格式的语言，同时也可以说明数据的验证方式。在前端架构的领域中，可以用 JSON 模式来描述模板和模式所需要的数据。JSON 超模式甚至可以描述能够通过 HTTP 协议与设计系统交互的方法，包括验证、渲染和测试。JSON 模式是一种代码驱动的文档工具，因为它提供了验证和驱动编辑工具的功能。JSON 模式还提供了可读性很强的系统手册，取代了开发者实现一个功能所需的一大堆手写说明。

以上是日照网站建设公司（昊诺网络公司）分享，如果你想了解更多的网站建设知识请关注我们网站的动态！