标题层级规范 🪞
- 一级标题:
# 主题名称
(用于主文档或章节) - 二级标题:
## 子主题
(用于子章节) - 三级标题:
### 细节说明
(用于具体说明部分)
段落与排版 📝
- 段落之间保留空行
- 每段首行缩进2个字符
- 代码块使用 ``` 语法包裹,如:
def example(): print("Hello, World!")
- 术语定义需用 加粗 标记,例如:API(应用程序编程接口)
语言风格要求 🗣️
- 使用简洁明了的中文表达
- 避免冗长句子,保持口语化
- 代码注释需用中文说明功能与逻辑
附录与扩展阅读 📚
- 参考 Documentation/writing_guidelines 了解写作规范
- 查看 Documentation/terminology 获取术语表