Markdown documentation style guide. Use when creating or editing markdown files in md/ directory.
name docs-style description Markdown documentation style guide. Use when creating or editing markdown files in md/ directory. 文档编写规范 通用 Markdown 规范 中文优先 所有文档使用中文 技术术语无合适翻译时可用英文 格式要求 使用表格替代冗长说明 代码块标注语言类型 使用相对路径引用项目内文件 md/ 目录结构 md/ ├── AI/ # ❌ AI禁止编辑 ├── 规划/ # 功能规划文档 │ ├── SDK/ # SDK 接口定义 │ ├── 通用/ # 业务逻辑（框架无关） │ └── {框架名}/ # 各框架实现约束 └── 总结/ # 复杂工作的总结文档 规划文档规范（md/规划/） 编写原则 应写 不应写 接口定义 版本号 代码模式 依赖配置模板 使用示例 安装命令 核心用法 冗余说明 框架无关约束 md/规划/通用/ 目录必须框架无关： ❌ 不得出现具体框架/库的实现方式 ✅ 只描述抽象概念和原则 ✅ 具体实现由各框架文档定义 代码定义规范 SDK 接口和 ViewModel 接口使用 Dart 代码定义 代码应简洁，只含接口签名，不含实现 其他语言/框架参照 Dart 接口转换 严格约束 禁止使用"或"、"可选"、"建议"等模糊表述 规范是强制性的，不得自由发挥 总结文档（md/总结/） 复杂工作完成后的总结 只能 生成到此目录。 禁止编辑区域 目录 说明 md/AI/ 开发者对话目录，AI 禁止编辑