文件名称：open-doc-contents
文件大小：190KB
文件格式：ZIP
更新时间：2024-03-28 09:13:44
文档首页 文档首页作为一个软件的文档的首页，其目的是为用户提供一个整体的视角来了解该软件核心功能，以及相关的文档结构组成，使用能够快速将该产品有一个大致的了解。 产品介绍 通过精炼的词汇，点出该产品的功能和适用范围，让读者能够了解该软件的核心功能及作用，从而判断该产品的定位以及是否需要继续了解下去。 精炼的产品介绍可以参考以下几个方面： 该产品的是什么？ 该软件产品进行下定义，提供一个准确的定义描述。 文档目录编写规范的英文对开源软件文档内容归纳的分类照片参考。让文档输出考虑的范围清晰明确，让读者能够快速根据需要索引到目标知识点。 该产品有什么作用？ 该产品的核心功能介绍，让读者快速了解到该产品的功能。 文档目录编写规范编写文档目录编写规范将常见的开源软件文档归纳为产品简介，使用手册，部署运维，性能，安全，最佳实践，原理解析，参考手册和参考标准的描述，为文档编写人员提供对产品类别产品整体的
【文件预览】：
open-doc-contents-master
----ops()
--------monitor.md(15B)
--------READMEE.md(16B)
--------ops-faq.md(12B)
--------backup-restore.md(15B)
--------before-install.md(31B)
--------README.md(5B)
--------inspection.md(15B)
--------get-software.md(125B)
--------install.md(102B)
--------upgrade.md(43B)
----doc-contents.png(188KB)
----standard()
--------README.md(5B)
----reference()
--------api.md(0B)
--------cli.md(0B)
--------server-config.md(0B)
--------sdk.md(0B)
----brief-intro()
--------history.md(63B)
--------release-node.md(109B)
--------news.md(87B)
--------README.md(5B)
--------core-competitiveness.md(82B)
--------glossary.md(69B)
--------what-is-this.md(211B)
----best-practices()
--------README.md(15B)
--------best-practices.md(0B)
----SUMMARY.md(1KB)
----principle()
--------README.md(10B)
----perf()
--------README.md(52B)
----manual()
--------function-overview.md(139B)
--------quick-start.md(67B)
--------README.md(60B)
--------concepts.md(202B)
--------use-limit.md(129B)
--------use-manual.md(170B)
----book.json(2KB)
----README.md(2KB)
----security()
--------README.md(10B)
----.gitignore(148B)