欢迎访问本项目文档规范页面!以下是关于如何编写和维护技术文档的详细说明:
📚 文档结构规范
标题层级
使用#
表示主标题,##
表示子标题,保持结构清晰
✅ 示例:# 主标题 ## 子标题
代码块格式
使用三个反引号包裹代码,语言类型需标注
✅ 示例:```python def example(): print("Hello, World!")
图片插入规范
关键词需替换空格为下划线,建议与当前内容相关
📎 示例:
🛠 扩展阅读
📌 注意事项
- 文档内容需遵循大陆地区政策
- 禁止包含任何敏感信息
- 保持语言简洁明了,避免冗余