如何写文档
2020-09-01 本文已影响0人
前端技师胡帅博
写文档基本套路，拿这个k8举例子
1.把主题的历史来一遍，提一下作者 比如：https://juejin.im/post/6854573211556937741
2.把它的作用 设计思想 来一套 https://www.kubernetes.org.cn/kubernetes%E8%AE%BE%E8%AE%A1%E7%90%86%E5%BF%B5
3.去抄一个原理图 https://www.cnblogs.com/liyuanhong/articles/10144759.html
4.文字复数这个原理图
5.写一个demo，随便弄就好，有代码截图就可以了
6.如何使用 https://www.kubernetes.org.cn/8211.html 不要全抄，随便弄点
7.得出结论
ps：不管有没有关系，上关系图。就是搜到的图片，不管对不对得上，一律想办法弄进去
