文档建设

一、文档建设（项目wiki）

1. 意义

• 方便成员快速了解和上手项目，也方便后期的交接工作
• 项目过程中，对各个环节存在的问题进行记录，方便后期进行项目回顾，避免踩坑，促使团队和产品不断完善
• 对于技术方面的沉淀做记录，方便大家及时学习和回顾，并且查漏补缺

2. 文档完善途径

• 完善项目相关wiki（见3）
• 完善代码
  • readme文件
  • 代码注释

3. 文档目录

• 1. 项目简介（在项目研发过程中逐步完善）
  • 项目各个环境的地址和账号
  • 业务逻辑
  • 重点功能模块实现逻辑
• 2. 需求文档（实时更新）
• 3. 里程碑（各个节点记录）
• 4. 问题沟通与反馈
• 5. 项目回顾
• 暂时想到这么多，其他内容根据需要进行补充

4. 使用

二、markdown文档常用方法

1. 标题

四级标题

五级标题

六级标题

2. 有序列表和无序列表

主要用到-、*、>符号

• 1. 有序1
  • 无序
  • 无序
• 2. 有序1
  • 无序
  • 无序

1

2

3

3. 打开网络链接的三种写法

• [用友][arbitrary_id]
  • 用友
• [用友](https://www.yonyou.com/)
  • 用友
• [yonyou][]
  • yonyou

4. 引入图片

方法：
![示例图片](https://img.haomeiwen.com/i14735639/7088400774c60dd8.jpg?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240)

呈现：

示例图片

5. 表格

| 参数 | total | pageSize | |:--:| :---: | :--: | | type | Number | Number | | description | 数据的总条数 | 每页返回的条数 |

• 应用场景

  • 我们可以在项目的readme文件里对于复用度较高的组件进行描述等

  readme文件示例

  路径：src/compoments/pagination
  应用场景：表格下方的分页
  传入参数：

  参数	total	pageSize
  type	Number	Number
  description	数据的总条数	每页返回的条数

  与父组件通信：

  • paginationChange

    • isSizeChange
      • type: Boolean
      • description: 是否改变页面显示数据的数量
    • val
      • type: Number
      • description: 页面显示的条数 / 当前页码

6. 代码

    foo = (1, 2, 3, 4)
    import request from '@/utils/request'
    import { api } from './apiUrl'
    // 获取待处理列表
    export function getUnApproval() {
      return request({
        url: api.unApproval,
        method: 'get'
      })
    }
    // 获取已处理列表
    export function getApproval(params) {
      return request({
        url: api.approvals,
        method: 'get',
        params
      })
    }
    // 修改审批状态
    export function updateApproval(params) {
      return request({
        url: api.updateApproval,
        method: 'put',
        params
      })
    }
    // 获取图片
    export function getImg(params) {
      return request({
        url: api.getImg,
        method: 'get',
        params
      })
    }

代码