文档标准指南 📚
欢迎访问文档标准页面!以下是关于文档编写的通用规范与建议:
1. 写作规范 ✅
- 语言简洁:避免冗长描述,使用清晰简短的语句
- 结构清晰:通过标题层级(如
##
、###
)划分内容模块 - 术语统一:关键概念需保持全文档一致性,例如:
API
应始终大写 - 格式规范:代码块使用 ``` 语法,列表用
-
或1.
表示
2. 图片示例 📷
3. 扩展阅读 🔗
如需了解更详细的文档编写指南,请访问:文档概述
或查看 API设计规范 获取具体细则
4. 版本控制 🔄
- 所有文档需标注版本号(如
v1.2.0
) - 重大更新需在开头添加
<!-- 更新日志 -->
标记 - 历史版本可通过
[[v1.1.0]]
链接跳转
📌 提示:语言风格标识(如
/en/
)可动态切换内容,当前默认为中文版本
🚫 注意:涉及政治、色情等敏感内容的请求将被拒绝