first commit
This commit is contained in:
25
docs/README.md
Normal file
25
docs/README.md
Normal file
@@ -0,0 +1,25 @@
|
||||
# 项目文档
|
||||
|
||||
## 文档结构
|
||||
|
||||
- `api/` - API接口文档
|
||||
- `development/` - 开发相关文档
|
||||
- `deployment/` - 部署相关文档
|
||||
|
||||
## 文档管理规范
|
||||
|
||||
1. 所有文档必须包含:
|
||||
- 目标 | 版本号 | 责任人 | 最后更新日期
|
||||
- 变更记录(含修改人、修改内容)
|
||||
- 关联资源链接(代码库/任务编号)
|
||||
|
||||
2. 文档更新必须:
|
||||
- 更新版本号(语义化版本 v<主>.<次>.<补丁>)
|
||||
- 提交变更日志(>50字说明)
|
||||
|
||||
## 快速链接
|
||||
|
||||
- [API文档](./api/README.md)
|
||||
- [开发文档](./development/README.md)
|
||||
- [部署文档](./deployment/README.md)
|
||||
|
||||
Reference in New Issue
Block a user