# template-design

**Repository Path**: markdown-lang/template-design

## Basic Information

- **Project Name**: template-design
- **Description**: 软件设计文档的模板项目。
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-03-02
- **Last Updated**: 2025-12-15

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# My Awesome Project

使用 [Markdown](https://spec.commonmark.org/0.31.2/) 编写设计文档。

一个可以转换为实现代码的设计文档，应具备以下内容：

1. 业务场景或用例
2. 程序模块
3. UI
4. API
5. 表结构
6. 主数据

## 编写文档

使用 [vitepress](https://vitepress.dev/) 编写文档。

```sh
# 安装依赖
npm install
# 边写边看
npm run docs:dev
# 构建
npm run docs:build
```