logo

功能划分

@JIYI @Leader

基于 Gitbook 的项目文档功能划分与说明

示例:这里介绍项目的功能划分情况,需要根据自己项目的情况进行划分说明。可以根据项目前期需求。比如一个 Web 项目,可能分为前端、后台,而后台有可以分为 web api 模块,以及第三方接口部分。如果仅仅是 API 后台,那这里就可以只介绍需求说明,再对应给出每个 API 的说明内容即可。实际上不管什么项目,以任何一个人视角看本说明都能一目了然:需求功能实现如何使用

目录内容

只给出简单结构示例,大家根据自己项目实现

本文档包含以下内容:

1. 功能需求

2. 功能说明

2.1. web服务接口

2.2. 对外接口功能

2.3. 定时执行功能

3. 参考

  1. https://redis.io/
  2. https://jiyiren.github.io/2018/08/04/kafka/
Copyright © csyiji@gmail.com 2019 all right reserved,powered by Gitbook该文件修订时间: 2019-09-15 16:10:42

results matching ""

    No results matching ""