乐鑫 ESP-FAQ：快速查找常见问题

ESP-FAQ 是由乐鑫官方推出的针对常见问题的总结。可以在线帮助用户快速检索常见问题，通过简单的搜索获得解答。

项目愿景: 通过搜索快速获取问题的答案，让问题解答更加高效，长期沉淀以供后者。

现有困境

• 当遇到问题，需要花费较多的时间在网络上搜寻答案，逐个尝试排查，耗费较多的时间往往不能收获满意的结果。
• 当相同标题出现多种答案时，无法准确区分答案的准确度与适用条件，导致试错成本增加。
• 通用且常见问题，未有规范的收纳总结，往往不能成为通用的解决方案或者参考。

ESP-FAQ 的优势

• 官方维护迭代，框架与内容完全开源，会不断更新以提供全面优质的答案与更加便利的使用体验。
• 节省时间成本，当您遇到问题寻求答案时，可以很快找到自己想要的信息，这将节省问题处理的时间成本，让问题处理更加高效。
• 便捷的操作，网站具有完善的搜索功能，可以根据关键字匹配到期望的信息，并且问题也会按功能模块分类，让您使用更加便捷。
• 知识的共享，问题将会汇总与收集，出现并解答的过的问题都会整理成册，以供后续使用者进行参考借鉴。
• 寻求解答，如果您期望问题解答没有搜索到，可以创建 issue 寻求解答，会有专业的团队答复并收集您的问题。

框架结构

• 使用说明
• 开发环境
• 应用方案
• 软件平台
• 硬件相关
• 测试校验
• 商务问题

应该如何使用

• 输入关键词搜索问题：wifi mesh
• 查阅右侧搜索结果，点击预期匹配结果查看。
  

搜索小技巧

搜索关键词

将问题中的关键词提取出来并搜索它们，此时搜索结果会得到最匹配的结果。

• 比如问题为：ESP32 的 Bluetooth LE 吞吐量是多少？
• 此时搜索：ESP32、BLE 和 吞吐量 等关键字为宜。

排除某个关键词

在搜索内容中添加一个标识符 -, 格式为： 关键词 - 排除关键词。此时搜索结果不会出现有排除关键词的结果。

• 比如搜索：ESP32 -ble。任何搜索结果中有 ble 的结果将会被过滤。

专业的寻求解答

• 如果您期望的问题解答没有搜索到，并且问题未包含私有信息。
• 您可以通过在 ESP-FAQ issue 中创建 Ask issue 寻求解答。

贡献与修正

• 您可以阅读 文档贡献 并提交 PR，我们将不胜感激。