@flyeric0212/demo-document

---
description: 
globs: *.md
alwaysApply: false
---
# 文档规范

## README.md 规范
- 保持文档结构清晰，使用适当的Markdown标记
- **重要**：确保README包含以下部分：
  - 项目简介
  - 安装说明
  - 使用方法
  - 贡献指南（如适用）
  - 许可证信息

## CHANGELOG.md 规范
在要求更新CHANGELOG.md时，请按照以下格式进行更新：
```
## v1.0.0
- 新增功能: 重置设备ID
- 修复bug: 修复设备ID重置失败的问题
```

## 文档更新原则
- 保持文档与代码同步更新
- 使用简洁明了的语言
- 提供足够的示例和说明
- 确保文档格式一致

═══════════════════════════════════════════════════════════════════
═══ ENGLISH TRANSLATION ═══
═══════════════════════════════════════════════════════════════════

---
description: Documentation Standards
globs: *.md
alwaysApply: false
---

# Documentation Standards

## README.md Standards
- Keep documentation structure clear, use appropriate Markdown markup
- **Important**: Ensure README includes the following sections:
  - Project Overview
  - Installation Instructions
  - Usage Examples
  - Configuration Options
  - Contributing Guidelines
  - License Information