欢迎参考框架A的文档编写规范,确保技术文档的一致性与专业性。以下是核心指导原则:
1. 文档结构规范
- 标题层级:使用
#
到######
表示不同层级标题 - 代码块:用
python 或
bash 包裹代码示例(⚠️注意:若路径含语言标识,需动态替换为对应语言) - 列表格式:无序列表使用
-
,顺序列表使用1.
- 图片插入:关键术语后穿插示例图(如需)
2. 写作风格要求
- 简洁性:避免冗长描述,使用短句表达核心概念
- 一致性:术语、缩写需全文统一(如API调用示例)
- 可读性:段落间用空行分隔,复杂概念需配图说明
3. 示例图参考
4. 相关文档链接
请严格遵循本规范,确保文档质量! 🌟