# BaseSDD

**Repository Path**: yu_sheng/BaseSDD

## Basic Information

- **Project Name**: BaseSDD
- **Description**: 软件设计文档 Software Design Document    基本文档
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 8
- **Forks**: 2
- **Created**: 2019-08-24
- **Last Updated**: 2025-07-16

## Categories & Tags

**Categories**: ebooks-manual

**Tags**: None

## README

# BaseSDD

QQ 群：45686341

BaseSDD 是基于 vuepress 开发、mackdown 编辑的**文档**、**记录**、**api**，**解决方案** 搜索站点
探针深度 ### 即 h1 h2 h3 的深度 3 级导航

<h1>已经部署，持续集成 </h1>

[在线地址](https://devyusheg.netlify.com/)

下载代码后 需要先行安装 vuepress

```
npm install -g vuepress
```

安装相关环境

```
// 在项目 根目录下
npm install
```

运行 npn run dev 启动服务
打开：**localhost:8080** 即可查看

## 文件夹对应文档

```
  /01fsr   可行性研究报告
  /02mdp   模块开发卷宗
  /03opm   操作手册
  /04sum   用户手册
  /05dsr   软件需求说明书
  /06gds   概要设计说明书
  /07dds   详细设计说明书
  /08dts   数据要求说明书
  /09ddm   数据库设计说明书
  /10pdp   项目开发计划
  /11mdpr   开发进度月报
  /12ttp   测试计划
  /13tar   测试分析报告
  /14pim   项目实施说明书
  /15pdsr   项目开发总结报告


```

## 原则

1. 原则上以语言、架构为创建文件夹的依据，如果如 vue、vue-router、vuex 这样的将统一放到 vue 文件夹下 新开分组进行编写

2. 尽量将标题 api 的主项保持在 3 级分类内 以便搜索

## 配置

1. **docs** 下边创建相应的文件夹
2. 在 **.vuepress/config.js** 中配置如下示例

   1. 在 sidebar 下添加如下配置
   2. 修改 **/html/** 为相应文件夹名称， 会将此名称作为一层网络地址进行编译
   3. **/html/** 的 3 个子集为侧边栏的分组，可相应调整
   4. 个分组的相应页面为 写在函数内，函数写在配置的最下边，**函数命名** 驼峰命名,仿照示例，需带有文件夹相应的关键词以进行区分
   5. 创建页面只需要加入到相应分组即可

3. 创建完成后 需要将路径配置到网站的主页 也就是 home 页面
   home 页面为 docs/README.md 如没有相应分类 可添加一个分类

```
'/html/': [
    {
        title: '基础',
        collapsable: false,
        children: genHtmlEssentialsSidebar()
    },
    {
        title: '进阶',
        collapsable: false,
        children: genHtmlAdvancedSidebar()
    },
    {
        title: '其它',
        collapsable: false,
        children: [

        ]
    }
],

// TODO: html 对外路径配置
function genHtmlEssentialsSidebar(type = '') {
  const mapArr = [
    '/html/',
    '/html/essentials/essentials.md',

  ]
  return mapArr.map(i => {
    return type + i
  })
}

function genHtmlAdvancedSidebar(type = '') {
  const mapArr = [
    '/html/advanced/advanced.md',
  ]
  return mapArr.map(i => {
    return type + i
  })
}
```

open http://localhost:8080/

> Generator by [vuepress](https://github.com/vuejs/vuepress)