
工作感悟
程序员通用技能、心得
年更yao
这个作者很懒,什么都没留下…
展开
-
代码 review 注意事项 check list
代码review checklist原创 2022-07-15 18:30:43 · 810 阅读 · 0 评论 -
如何写一个代码分析文档
持续更新目录1.给出这段代码的功能描述,让读者知道这篇文章主要介绍哪一部分2.这段代码入口方法,以及如何找到入口类、方法3.给出结论的代码调用图4.具体代码说明5.总结1.给出这段代码的功能描述,让读者知道这篇文章主要介绍哪一部分2.这段代码入口方法,以及如何找到入口类、方法3.给出结论的代码调用图(1)跟那些组件有交互(2)跟哪些关键类代码有交互...原创 2018-11-08 01:16:23 · 9391 阅读 · 0 评论 -
如何从0开始了解一个存储引擎
根据本人浅薄的经验,了解一个数据引擎可能涉及以下问题:目录1. 概念2. 架构3. 部署4. 元数据5. 写数据链路6. 查询链路阶段总结一些经常被关心的功能和特点7. 旧数据清理8. 数据的hash9. 离线文件导入导出10. 故障恢复时间11. 对比其他DB1. 概念 先粗略看看是否适合自己的需求,从官网/社区/技...原创 2018-11-08 00:16:03 · 803 阅读 · 1 评论 -
写技术文档需要注意什么
技术文档总是令人头大,一是文档内容可能不够全面,可读性差,可操作性差二是不知该从何写起,在此简单总结一下之前的内容和思路: 目录一.操作类、代码demo文档二.技术介绍类文档一.操作类、代码demo文档 此文档用于解决:xxxx 给出具体登录哪个机器/哪类机器,ssh登录还是通过堡垒机登录,或者其他登录方式 没有登录权限找谁开通 给出...原创 2018-11-07 18:13:18 · 2157 阅读 · 0 评论 -
公司内如何建设、管理分布式存储项目
线上:关注社区发展,了解最新的feature 各个feature可能发展速度不一样,一些易用性方面的以及功能方面的可能应用速度比较快,比修改“核心”去提升性能的feature发展速度更快;可能易用性和功能的提升能比几毫秒的性能提升带来更多的用户; 线下:关注社区发展,参与社区的活动,听各种讲座,论坛 现场学习的效果与远程学习或者自己看社区jira的效果要好很多; 大牛们会现场讲...原创 2019-10-04 16:08:29 · 490 阅读 · 0 评论 -
测试文档编写原则
以下内容作为建议,实际情况不限于以下内容:测试背景:例:0.xx升级1.x.x api兼容性(这里写了几个关键词,自己补充)测试环境:具体客户端机器,具体路径 ,具体服务端机器,服务部署路径,配置测试过程:列出具体参数,脚本,执行命令。程序git地址都测试哪些要素,QPS? API? 流量? 其他?测试过程中除了测试的要素变化以外,其他的所有要素都不要变化,也不要引入其他程序/...原创 2019-10-04 15:32:36 · 532 阅读 · 0 评论 -
操作类、代码demo文档编写原则
根据之前的经验,总结了一些文档编写中需要注意的事项、用户阅读文档常见需求:一.操作类、代码demo文档此文档用于解决:xxxx 给出具体登录哪个机器/哪类机器,ssh登录还是通过堡垒机登录,或者其他登录方式 没有登录权限找谁开通 给出文字版操作命令,wiki code模式给出,文本模式格式有问题:这里不要截图,用户习惯从wiki粘贴命令再修改之后执行,当然也不要写一个有危险的命令,而...原创 2019-10-04 15:31:45 · 420 阅读 · 0 评论 -
如何写一个代码分析文档
1.给出这段代码的功能描述,让读者知道这篇文章主要介绍哪一部分2.这段代码入口方法,以及如何找到入口类、方法3.给出结论的代码调用图(1)跟那些组件有交互(2)跟哪些关键类代码有交互4.具体代码说明(1)关键的方法调用链路,文字描述/图(2)定义了哪些主要的数据结构,写出数据结构中存了什么信息(3)如果和多线程有关,说明线程之间的调用关系5.总结(1)重要的...原创 2019-10-04 15:26:02 · 2139 阅读 · 0 评论