常用结构

行内规范

常用的结构

（一）国际化

（二）项目工程介绍

（三）项目的使用效果图

（四）项目特点

（五）项目的基本结构（架构）

（六）集成方式

（七）使用方法

（八）混淆

（九）关于作者/组织及交流方式等信息。

（十）贡献者/贡献组织

（十一）鸣谢

（十二）版权信息

国际化

在文件的开头就应该准备至少两份语言文档

项目工程介绍

• 项目名称、logo（没有logo就不写）

• 这个开源项目是做什么的？

• 这个项目是什么语言编写的？

• 这个项目目前被多少人用到了，有多少好评等？

• 项目维护、依赖更新状态（如果有的话，这也可以用）等

• 项目可用版本及其他版本，以及每个版本的更新信息记录

• Demo 或官网地址（如果有）