本文只是简单记录编写技术文档的主要结构,以供参考。

结构

介绍/描述

简单的介绍项目的背景信息。

目录

目录是结构的直接体现。

术语

术语解释。对于很多业务会有特定的词汇,需要单独解释。

Setup

如何部署或者安装项目。

Body

文档的主体部分,具体结构需要根据内容来确定。

Reference

文档中引用的其他相关需求或者资料。

FAQ

其他人经常问的问题,遇到就记录在这个模块中,不断补充。

ChangeLog

变更日志。记录每个版本的重要变更。

Release

开源项目通常会有一个单独的 Release 发版页面。

参考