Repository navigation

139 lines (100 loc) · 1.92 KB

知识卡片

基本信息

字段	内容
标题
日期	YYYY-MM-DD
类型	踩坑记录 / 技术方案 / 学习笔记 / 最佳实践
标签	#标签1 #标签2 #标签3

踩坑记录模板

症状

[看到了什么错误/现象？错误信息是什么？]

[错误日志/堆栈信息]

环境

项目	版本/信息
OS
语言/运行时
框架
相关依赖

排查过程

[第一步尝试了什么，结果如何]
[第二步...]
[关键发现...]

根因

[最终发现的原因是什么？]

解决方案

[具体怎么修的]

[关键代码/配置变更]

教训

下次如何避免：
如何更快定位：
需要补充的监控/测试：

参考

[相关链接/文档/Issue]

技术方案模板

场景

[什么情况下需要这个方案？解决什么问题？]

方案描述

[具体实现方式]

关键代码

[核心代码片段]

优缺点

优点	缺点

替代方案

方案 B：[简述] — 适用场景：
方案 C：[简述] — 适用场景：

注意事项

[使用时的坑/限制]
[性能考虑]
[兼容性问题]

参考

[相关链接/文档]

学习笔记模板

主题

[学了什么？]

核心要点

关键代码/命令

[示例]

与现有知识的关联

和 [已知概念] 的关系：
可以用在 [项目/场景]：

疑问/待深入

[还需要了解的点]

参考

[学习资源链接]

最佳实践模板

实践名称

[这个最佳实践是什么？]

适用场景

[什么时候应该这样做？]

具体做法

[步骤/规范]

为什么这样做

[原理/好处]

反模式

[不应该怎么做？为什么？]

示例

[好的示例 vs 坏的示例]

参考

[相关链接/文档]