Getting Started
Last revision 2025/11/30
该内容对Wiki的各个核心板块做了详细的定义说明，用于快速检索各版块功能。
Wiki各版块内容定义：
| 板块 | 撰写人 | 定义 | 核心内容 |
|---|---|---|---|
| Docs | PM | 该板块呈现产品的基础使用说明和相关资料。 1.Example Code 2.Reference。 |
1. 首次使用需知（比如注意事项、防呆提示等） 2. 示例代码（一个完整项目一个Docs，避免出现一个Docs里面有多个样例） |
| Tech Specs | PM | 该板块呈现产品的技术规格，用于描述产品性能参数和接口定义的核心部分。 | 1. 参数说明（以表格形式） 2. 引脚说明（以图片 + 表格形式） |
| Tutorials | 技术支持 /PM | 该板块呈现产品的相关综合项目教程，或解决某个特定技术问题的教程。 Docs与Tutorials板块的区别：Docs的内容是该产品的基础使用文档，Tutorials的内容是解决用户综合应用场景中可能遇到的相关问题。 |
1. 组合使用教程（多传感器、扩展板、总线协同） 2. 高频问题的解决方案 3. 综合应用项目教程 |
| Courses | 课程 | 该板块呈现产品的系列课程。 Tutorials与Courses的区别：Tutorials不强调内容的体系化与连续性，Courses强调内容的体系化与连续性 |
从Learn平台自动抓取，Courses内容需上传至Learn平台 |
| Projects | 市场 /PM | 该板块呈现产品在社区的优质内容，提供可学习与可复现的项目示例。 | 从商城页自动抓取，Projects内容需上传至Community。 |
| Certifications | PM | 该板块呈现产品的相关认证报告。 | CE / FCC / RoHS / REACH / TELEC 等测试报告与证书 |
| FAQ | 技术支持/PM | 该板块是产品的常见问题。 | 从Forum平台自动抓取，FAQ需上传至Forum平台。FAQ 帖需打上相关标签。 |
需每位撰写人重点关注：
以下注意事项核心考虑对WIKI长期价值，便于AI检索与SEO优化
- WIKI标题需重点关注，WIKI标题名称务必不能写错。
- 所有图片需补充图片名称与图片描述，图片描述能尽可能体现产品SKU及功能说明，增加描述有利于AI检索。
- 图片未上传到公司服务器，需重新上传。防止外链增加防火墙，永久无法访问图片。
- Tech Specs、Reference 需尽可能详尽展示产品相关技术资料，比如电气特性，接口通信协议、库兼容适配、具体功能等，有利于AI判断兼容性问题。
- 撰写内容尽量以表格形式呈现，秉持能用表格就不用图片的原则，表格更有利于AI检索。
- 如页面有外部有效链接需保留，有利于SEO外链引用。后台SEO标题、SEO关键词、SEO描述，无需手动填写。
- 若需展示动态效果，使用MP4 视频格式，避免使用 GIF。
- 一级
- 二级
- 三级
- 二级
✅ ❌ ⚠️ ❗ ⏳ ⬆️ ⬇️ ➡️ ⬅️ ✏️ ⭐ ⚡ ✋ ➕ ➖ ⛔ ♻️
✔ ✘ ● ○ ★ ☆ → ← ↑ ↓ ？
Was this article helpful?