整理中文文档结构与索引
This commit is contained in:
34
doc/debug/调试文档索引.md
Normal file
34
doc/debug/调试文档索引.md
Normal file
@@ -0,0 +1,34 @@
|
||||
# 调试文档索引
|
||||
|
||||
这一组文档用于记录:
|
||||
|
||||
- 平台能力边界
|
||||
- 传感器问题排查
|
||||
- 模拟器日志方案
|
||||
- 当前调试约束和回归重点
|
||||
|
||||
## 当前主文档
|
||||
|
||||
- [平台能力说明](/D:/dev/cmr-mini/doc/debug/平台能力说明.md)
|
||||
用于记录主体能力、`web-view`、传感器等平台边界。
|
||||
- [模拟器调试日志方案](/D:/dev/cmr-mini/doc/debug/模拟器调试日志方案.md)
|
||||
用于说明 mock simulator 的日志旁路与 `debug-log` 协议。
|
||||
- [传感器当前状态总结](/D:/dev/cmr-mini/doc/debug/传感器现状总结.md)
|
||||
用于看当前已确认的传感器状态与调试结论。
|
||||
- [罗盘问题记录](/D:/dev/cmr-mini/doc/debug/罗盘排障记录.md)
|
||||
用于回看 Android / iOS 罗盘保活链的排查过程。
|
||||
|
||||
## 推荐阅读顺序
|
||||
|
||||
1. [platform-capability-notes.md](/D:/dev/cmr-mini/doc/debug/平台能力说明.md)
|
||||
2. [sensor-current-summary.md](/D:/dev/cmr-mini/doc/debug/传感器现状总结.md)
|
||||
3. [mock-simulator-debug-log-proposal.md](/D:/dev/cmr-mini/doc/debug/模拟器调试日志方案.md)
|
||||
4. [compass-debugging-notes.md](/D:/dev/cmr-mini/doc/debug/罗盘排障记录.md)
|
||||
|
||||
## 使用建议
|
||||
|
||||
- 看“当前限制”和“为什么会这样”,优先看平台能力说明。
|
||||
- 看“现在系统是什么状态”,优先看传感器现状总结。
|
||||
- 看“以后日志怎么打”,优先看模拟器日志方案。
|
||||
- 看“为什么罗盘以前坏过”,再去看罗盘问题记录。
|
||||
|
||||
Reference in New Issue
Block a user