# docs-manager

**Repository Path**: secretx500/docs-manager

## Basic Information

- **Project Name**: docs-manager
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-07-04
- **Last Updated**: 2021-07-25

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## 代码问题

- 服务端代码放到: /server 目录下

- 说明文档放到: /docs 目录下(比如数据库设计, 比如需求文档, 项目部署文档)

## git 分支问题

- 自己写代码前, 先创建一个分支, 最好用自己的姓名缩写作为分支名(比如 lh)

- 写完一个功能, 将代码 merge 到 dev 分支, 然后提交, 写代码之前记得要先 pull 一下,否则容易冲突

## 编码规范

一定要用支持 editorconfig 的编辑器

## 文档问题

问题注意用 markdown 文件写, 比如数据库字段设计, 比如 api 接口

## 查看/修改文档问题

- 数据库字典: docs/db.md
- API 文档: docs/api.md
- 需求文档: docs/demand.md

```bash
# 安装
npm i docsify-cli

# 查看文档
docsify serve ./docs
```