Getting Started Guide

Welcome developers to use Wiki Development Documentation!This guide aims to help software and hardware developers quickly understand the content structure and usage methods of Wiki, making your development work more efficient.Whether you are a beginner or an experienced developer, you can find learning and reference resources suitable for you in Wiki. If you encounter any document issues, please provide feedback in time and we will handle them promptly.

Wiki Target Audience

Wiki is an efficient knowledge base, especially suitable for the following developers:

  • Software Developers：Provides a complete set of development resources from beginner to advanced levels.

  • Hardware Developers：Covers essential documents and tools required for hardware design.

Please select the appropriate content for learning and reference based on your needs and development stage.

Content structure and usage instructions

1. 软件开发入门

If you are a user who is just starting to learn software development, it is recommended to start with the following sections:

  • 推荐阅读：

    • SDK Programming Guide

    • FAQ 常见问题解答

  • 主要内容

    • Suitable for users who want to get started quickly with development。

    • Providing detailed steps for setting up the development environment and implementing basic functions.

    • Covers common sample code and development techniques.

    • Help beginners quickly master development tools and basic knowledge.

  • Usage Steps：

    • 在 Wiki 主目录中找到 “软件开发 > SDK Programming Guide”。

    • 按章节顺序阅读，配合开发板完成示例代码实践。

    • 如遇问题，可前往 “软件开发 > FAQ 常见问题解答” 查找解决方案。

2. 软件开发进阶

Users with some development experience can directly enter deeper technical content:

  • 推荐阅读：

    • API 文档

    • 应用笔记

  • 主要内容：

    • 提供全面的 API 文档，包括函数说明、参数定义和使用示例。

    • Help developers quickly call interfaces and implement complex functions.

    • Covers best practices for common application scenarios.

    Usage Steps：

    • 查找需要的模块或功能所在的 “API 文档”。

    • Locate specific API interface documents according to module classification.

    • Read relevant sample code as needed and integrate it into your project.

3. 硬件开发

Hardware developers can use the hardware-related documents in Wiki to better complete design and development work:

  • 硬件设计指南：

    • Provide technical specifications for hardware design, schematic references, and PCB design recommendations.

    • Contains practical suggestions for design considerations and performance optimization.

    • Help developers understand the collaborative working methods of hardware and software.

    Usage Steps：

    • 进入 “硬件设计指南”。

    • Review the design specifications to ensure that your design complies with the recommendations in the document.

    • Download relevant document templates or reference designs according to project requirements.

Usage recommendations

  1. Keyword search：

    • If you are unsure of the location of the required content, please use the search function provided by Wiki.

    • Enter keywords, such as function name, interface name, or hardware module number, to quickly locate relevant content.

  2. Learn with sample code：

    • Wiki contains a large number of sample codes. It is recommended to combine them with actual projects for practice to deepen the understanding of the document content.

  3. Regularly check for updates：

    • Wiki documents will be updated regularly. Please pay attention to the update log on the homepage to obtain the latest development support information in time.

Technical support

If you encounter any problems while using Wiki, we recommend that you:

  1. Check the FAQ section, which lists common problems and their solutions.

  2. Contact relevant technical personnel for help through the technical support channels provided by the project team.

Thank you for using the Wiki development documentation! We hope it will become a valuable assistant on your development journey. Wishing you smooth work and successful projects!