基本准则
- 简洁明了：避免冗长表达，用最短的句子传递核心信息 ✅
- 逻辑清晰：段落间用过渡句衔接，确保读者能顺畅跟随思路 ➡️
- 术语统一：对专业名词保持固定写法（如“HTTP”而非“http”或“Http”） 🔍
格式规范
- 标题层级：使用
#到######表示不同层级标题，避免过度嵌套 - 代码块：用 ```markdown 语法包裹代码，关键词需替换空格为下划线（如
Python_示例） - 列表排版：无序列表用
-，有序列表用1.，保持缩进一致
扩展阅读
想了解更多关于技术文档的写作技巧？可以参考：course/style_guide