# 文档规范

**Repository Path**: github-28345505/wiki

## Basic Information

- **Project Name**: 文档规范
- **Description**: 文档正在建设中，可能会有变化，欢迎大家 PR
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2017-12-11
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 🚧 📖 WIKI · 知识库

## ⚠ 文档正在建设中，可能会有变化，欢迎大家 PR

### 📝 文档要求
- 文档书写请遵循： [中文技术文档写作规范](https://84hero.gitbooks.io/dockument-style-guide/content/)
- 文档统一使用 `Markdown`, 文件结尾为 `.md`
- 目录和文件命名必须使用 **小写英文字母**，单词之间以短横线 `-` 连接
- 该项目下不可以放置软件、音乐、视频等。文章图片需放置在 `images` 文件夹下
- 请根据目录说明，仔细考虑文章所属分类，放在其对应的目录下

### 🐕 文章索引
1. [指南](guide)
    - [前端技术栈](guide/frontend-tech-stack.md)
    - [开发项目指南](guide/project-guidelines.md)
2. [编程规范](standard)
    - [CSS 编程规范](standard/css)
    - [Javascript 编程规范](standard/javascript)
    - [PHP 编程规范](standard/php)
    - [数据库规范](standard/database)
3. [运维](ops)
    - 网络部署流程[待完成]
4. [工作流程](workflow)
    - [运营工作](workflow/operation)
        - [饭侠吉麦町](workflow/operation/fanxia)
            - [错误处理](workflow/operation/fanxia/error-handler.md)
            - [测试流程](workflow/operation/fanxia/testing-process.md)
    - [流程规范](specification)
        - [企业邮箱管理规范](workflow/specification/enterprise-email-spec.md)
        - [学习分享会规范](workflow/specification/study-and-share-spec.md)
        - 发版制度 [待完成]
5. [分享学习](share)
    - [郭振明](share/zm-guo)
        - [随笔一](share/zm-guo/start-one.md)
        - [流程管理](share/zm-guo/process-management.md)
        - [分享之未来百度、阿里巴巴、腾讯三巨头谁会独领风骚？](share/zm-guo/share-bat.md)
    - [王洋](share/wangyang)
        - [小麦市场余额抵扣功能的实现](share/yangyangyang/wheat-market-cost-pay.md)

### 🌵WIKI 目录说明
```
.
├── README.md
├── guide/                  #指南，最佳实践
├── images/                 #放置图片
├── ops/                    #运维相关
├── share/                  #学习总结文章
├── standard                #代码规范
│   ├── css/                
│   ├── database/
│   ├── javascript/
│   └── php/
└── workflow                #工作流程
    ├── operation/          #运营
    │   └── fanxia/
    └── specification/      #工作规范
```
### 📎 提交流程
1. 首先要认真阅读文档要求
2. 在对应的目录中建立 `Markdown` 文件， 以 `.md` 结尾
3. 开始编写文档,如果文档有配图，请放在 `images` 文件夹下
5. 编写完成后，认真检查文档有没有错别字
6. 像提交代码一样将文档提交，提交到 `draft` 分支
7. 登录 Gitlab , 提交 `merge request` , ✅ DONE!