【亲测免费】 中文技术文档写作风格指南教程

中文技术文档写作风格指南教程

1. 项目的目录结构及介绍

zh-style-guide/
├── source/
│   ├── conf.py
│   ├── index.rst
│   ├── xxx.md
│   └── ...
├── LICENSE
├── Makefile
├── README.md
└── ...

• source/：包含所有的源文件。
  • conf.py：配置文件。
  • index.rst：各章节目录文件。
  • xxx.md：各章节页面文件。
• LICENSE：项目许可证文件。
• Makefile：用于构建项目的Makefile。
• README.md：项目说明文件。

2. 项目的启动文件介绍

项目的启动文件主要是index.rst，它是整个文档的入口文件。通过这个文件，可以导航到各个章节和页面。

3. 项目的配置文件介绍

项目的配置文件是conf.py，它包含了文档的各种配置选项，如文档标题、作者、版本号等。以下是一些关键配置项的示例：

project = '中文技术文档写作风格指南'
copyright = '2023, yikeke'
author = 'yikeke'
version = '1.0'
release = '1.0'

通过修改这些配置项，可以定制文档的显示效果和内容。