文档的目录如何编写?

一般在编写文档的时候,每个人的写法千奇百怪。

我想问的是,类似如下问题:

一、目录1
  1.1、子目录1.1

二、目录2
  2.1 子目录2.1

为了阅读和理解,这样写好么?有什么通用的规范么?
(书写规范层面,不是代码实现)

阅读 2.7k
2 个回答

额,我有一个小demo和你说的差不多,能处理下面的这种数据结构。。。不知道你的数据结构是什么样的
项目地址:
https://github.com/Su739/china
预览:
https://su739.github.io/china/

var su = [
    {
      title: 'c1 - ecmascript语法',
      children: [
        {
          title: 'c1.1 - Array',
          children: [
            {
              title: 'c1.1.1 - Array.map()',
            },
          ],
        },
      ],
    },
    {
      title: 'c2 - DOM',
      children: [
        {
          title: 'c2.1 - Node节点',
        },
        {
          title: 'c2.2 - 事件',
          children: [
            {
              title: 'c2.2.1 - 事件冒泡',
            },
            {
              title: 'c2.2.2 - 事件对象',
            },
            {
              title: 'c2.2.3 - EventListener',
            },
          ],
        },
        {
          title: 'c2.3 - DOM3',
        },
      ],
    }
  ];

目录

1.PHP基础

1.1 PHP环境搭建

1.1.1 下载安装包
1.1.2 安装软件
1.1.3 修改配置文件
撰写回答
你尚未登录,登录后可以
  • 和开发者交流问题的细节
  • 关注并接收问题和回答的更新提醒
  • 参与内容的编辑和改进,让解决方法与时俱进