Files
TrueGrowth/.github/ISSUE_TEMPLATE/documentation.md

49 lines
1.0 KiB
Markdown

---
name: 文档改进
about: 帮助改进项目文档
title: '[DOCS] '
labels: 'documentation'
assignees: ''
---
## 文档问题
清晰简洁地描述文档中存在的问题。
## 文档位置
请指出问题所在的文档位置:
- 文件路径:
- 章节:
- URL (如果适用):
## 问题类型
- [ ] 内容缺失 - 缺少重要信息
- [ ] 内容错误 - 信息不准确或过时
- [ ] 内容不清晰 - 难以理解或有歧义
- [ ] 格式问题 - 排版、链接、代码示例等问题
- [ ] 翻译问题 - 中英文翻译不准确
- [ ] 示例代码问题 - 代码示例错误或无法运行
- [ ] 其他:
## 详细描述
提供更多关于问题的详细信息。
## 建议的改进
如果你有改进建议,请在此描述:
```markdown
你建议的文档内容
```
## 受影响的用户
这个文档问题会影响到:
- [ ] 新用户
- [ ] 经验用户
- [ ] 开发者
- [ ] 所有用户
## 附加上下文
在此处添加任何其他上下文或截图。
## 愿意贡献
- [ ] 我愿意提交PR来改进这部分文档