作为架构师,尤其是技术架构师,日常工作中经常遇到解决一些典型的问题。作为公司知识库积累的需要,需要将解决问题的思路进行进一步整理,保证传承和知识沉淀。
本文整理一个解决方案文档的标准模版结构:
目 录
第1章 概述
1.1 前言
1.2 编写目的
1.3 术语定义
1.4 参考资料
第2章 方案综述
2.1 什么是热更新
2.2 为什么要使用热更新
2.3 热更新的优点
2.4 常见的热更新解决方案
第3章 Ionic是如何热更新的
3.1 主要思路
3.2 工作原理
3.3 工作流程
3.4 实现过程
3.4.1 安装插件
3.4.2 安装插件CLI客户端
3.4.3 cordova-hcpinit
3.4.4 ionicbuild
3.4.5 ordova-hcpbuild
3.4.6 修改config.xml
3.4.7 App打包、发布
3.4.8 搭建服务器
3.4.9 上传更新
3.4.10 检测更新
3.4.11 安装更新
3.4.12 测试结果
第4章 注意事项
4.1 MIME类型
4.2 升级目录
第5章 常见问题
5.1 使用此插件会影响ios平台的审核吗?
5.2 其他
总体来说,这种文档最终目的是要讲清楚问题现象、问题分析过程、问题解决方案、注意事项、过程中遇到的问题等等。
尤其注意一点,不要只记录结果,不记录过程。这样回过头来,团队成员再看的时候其实会有很多问题。