# pangpang-doc

**Repository Path**: ptko/pangpang-doc

## Basic Information

- **Project Name**: pangpang-doc
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: develop
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-08-04
- **Last Updated**: 2026-08-29

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# pangpang-doc

> 企业级研发文档库 —— 涵盖开发规范、环境搭建、部署运维、技术笔记、项目模板与知识管理。

## 项目简介

pangpang-doc 是公司研发团队的统一文档库，旨在沉淀研发全生命周期的规范、指南与经验，统一团队协作标准，提升研发效率与代码质量。

## 目录结构

```
pangpang-doc/
├── README.md                          # 项目总览与使用指南（本文件）
├── docs/                              # 文档主目录
│   ├── 00-开发规范/                    # 团队协作标准
│   ├── 01-环境搭建/                    # 开发/测试环境配置
│   ├── 02-部署运维/                    # 生产环境部署
│   ├── 03-技术笔记/                    # 技术沉淀与方案记录
│   ├── 04-项目模板/                    # 可复用的文档模板
│   └── 05-知识管理/                    # 学习方法与工具
├── assets/                            # 图片、截图等资源文件
│   └── images/
└── scripts/                           # 自动化脚本（如生成目录、检查链接）
```

## 快速导航

| 模块 | 说明 | 入口 |
|------|------|------|
| **开发规范** | 前后端编码规范、Git 工作流、代码审查等 | [docs/00-开发规范](docs/00-开发规范/README.md) |
| **环境搭建** | JDK/Node.js/IDE 配置、中间件安装 | [docs/01-环境搭建](docs/01-环境搭建/README.md) |
| **部署运维** | Docker、CI/CD、服务器运维、云原生 | [docs/02-部署运维](docs/02-部署运维/README.md) |
| **技术笔记** | 架构设计、源码阅读、问题排查 | [docs/03-技术笔记](docs/03-技术笔记/README.md) |
| **项目模板** | README、API 文档、技术方案模板 | [docs/04-项目模板](docs/04-项目模板/README-模板.md) |
| **知识管理** | 学习方法、工具推荐、书籍资源 | [docs/05-知识管理](docs/05-知识管理/高效学习法.md) |

完整文档说明请参阅 [docs/README.md](docs/README.md)。

## 技术栈

- **后端**：JDK 25 · Spring Boot 4.x · Spring Data JPA · Gradle 8.x · MySQL 8.x
- **前端**：React 19.x · TypeScript 5.x · Ant Design 5.x · Vite 6.x

## 如何贡献

1. 遵循 [Git-工作流规范](docs/00-开发规范/Git-工作流规范.md) 进行分支管理与提交
2. 文档变更遵循 [文档书写规范](docs/00-开发规范/文档书写规范.md)
3. 新增文档可参考 [04-项目模板](docs/04-项目模板/) 中的模板

---

*本仓库由架构组维护，解释权归架构组所有。*