如何正确使用（阅读）本文

注意： 目前唯一文档官网： maixpy.sipeed.com

首先请仔细阅读一遍左边侧边栏的目录结构看一看文档有那些内容

• 刚接触，可以根据左边侧边栏的目录从上到下一页一页仔细看，跟着做即可。
• 学会如何更新固件，如何写代码，其中学会使用串口终端也十分重要，不建议过分依赖IDE

• 每个模块/库文档里面的结尾都附有简单例程， 或者到这里:[MaixPy_script](https://github.com/sipeed/MaixPy_scripts)查找需要的示例， 可以尝试运行看效果

• 最后关于模块的接口及参数，在使用时根据自己的需求进行查阅，左上角有搜索框，可以好好利用，同时也可以使用浏览器的页面搜索功能，即按键盘 Ctrl+F ，然后输入要搜索的内容后按确认键

• 如果有找不到的内容也请不要着急， 可以上 github 的 issue） 页面找一找（/搜一搜）是不是有人提过了，没有的话可以新建 issue, 或者到 论坛 向大家求助， 或者联系技术支持。

• 如果网页加载比较慢， 请尝试刷新或者等待， 或者换个线路（使用代理或者换手机流量试试）

• 文档使用 gitbook 从 markdown 自动生成为静态页面， 如果遇到有些页面无法访问， 请检查一下网址（路径）是否正确， 可以回到首页 (maixpy.sipeed.com) 重新进入即可。

比如这个网址就是由于点击过快导致的：

http://localhost:4000/zh/zh/how_to_read.html

正确的网址应该是：

http://localhost:4000/zh/how_to_read.html

• 除了文档，还可以浏览博客看用户写的教程

• 另外在 github 或者论坛提问时需要注意： 提问要尽量提供完整的问题复现步骤，方便开发者测试问题并解决！

• 常见问题请见常见问题