参考手册

位置


参考手册应位于/引用/ <产品族> / <产品名称> /参考手册

标题


标题应该是表单的第一级标题(======):<产品名称>参考手册

例:

====== Basys 3参考手册======

第一部分


第一部分应该包含产品概述段落,然后是使用Dokuwiki图片库插件.产品概述应强调:

  • 目标用户和应用程序
  • 关键特性(完整特性列表将在下一节中介绍)
  • 关键好处

不:

  • 包含页面标题和第一部分内容之间的任何标记。
  • 包括详细的技术规格

特性


特性部分包括产品特性的项目符号列表。

部分


section应该以表单的第一级标题(======)开始:<段号> <段名>

例:

====== 1与Arty设计======

  • 开始区段编号为1。
  • 用一条水平线将第一级标题与下面的内容分开

  • 在节号和节名之间包含一个句点。
  • 用水平线将第二级或更高级的标题与下面的内容分开

的程式


节可以有选择地包含子节。子部分应该以形式的三级标题(====)开始:<数>部分。<分段编号> <分段名称>

例:

==== 1.1外部电源电压监控====

  • 用x.1开始分段编号

  • 用一条水平线将小标题与下面的内容分开