周报-28|技术文档范例

前言 本篇是对 2023-07-10 到 2023-07-16 这周生活的记录与思考。首发在我的个人 博客,你可以移步了解更多或者给我留言。 读书、健身、投资、帮朋友、陪家人。 这是我的第 27 篇周报,由于工作的原因,前两周的周报是一起发布的,所以第 27 篇周报被跳过去了。 技术文档范例 以下是一个使用中文标题的技术文档范例: 一、介绍 1.1 目的 1.2 范围 1.3 受众 1.4 定义、缩略语和术语 二、概述 2.1 系统架构 2.2 主要功能 2.3 系统要求 三、入门指南 3.1 安装 3.2 配置 3.3 第一步操作 四、用户指南 4.1 用户界面 4.2 导航 4.3 功能 五、管理指南 5.1 系统配置 5.2 用户管理 5.3 安全性 六、故障排除 6.1 常见问题 6.2 错误消息 七、附录 7.1 发行说明 7.2 术语表 7.3 参考文献 以下是一个使用数字标题的 Spring Cloud Gateway 教程示例: 1. 介绍 1.1 目的 1.2 范围 1.3 受众 1.4 术语和定义 2. 概述 2.1 什么是 Spring Cloud Gateway 2.2 Spring Cloud Gateway 的优势 3. 快速入门 3.1 环境配置 3.2 创建Spring Cloud Gateway项目 3.3 配置路由规则 3....

周报-26|上半年的绩效总结

前言 本篇是对 2023-06-26 到 2023-07-09 这周生活的记录与思考。首发在我的个人 博客,你可以移步了解更多或者给我留言。 读书、健身、投资、帮朋友、陪家人。 这两周主要是忙于工作,Wekatime 上统计的上周每天平均编程时间达到了 6 hrs 52 mins,基本上每天都是早七晚七的上班节奏。于是,学习的时间都被工作占用了。工作的内容主要是整合多个系统实现 sso 登录,用到的技术有 SpringCloud、Spring Security Oauth2 等等。 另外,本周完成了上半年的绩效总结,回顾了这半年的工作内容。 绩效总结 1、项目方面的成果: a、完成了智能安防多个项目的迭代开发和上线,包括用户切换租户、报表发送到飞书、华为车牌识别、夜收模块拆分、巡检场景功能优化等。同时,也完成了通知模块重构、大屏报表支持多租户和门店、Dmallai 导航等需求的开发。这些工作的完成,为系统的稳定性和功能扩展提供了有力的支持。 b、共发布了 32 次版本,其中 7 次为功能迭代,25 次为 bug 修复。平均每月完成了 1 次项目迭代和 4 次 bug 修复,做到了及时响应和快速解决问题,提升了用户的使用体验和满意度,提高了系统的稳定性,降低系统的故障率和用户的投诉率,没有出现 P3 级别以上故障。 2、技术方面的成果: 利用空余时间学习新技术和框架,如 Pyhon、Rust、React,每周写周报和学习总结,总计输出 66 篇文章。 不断优化和迭代 Rose 框架,并将 Rose 合并到 Cocktail cloud,方便代码管理和维护。同时,Cocktail cloud 还增加了一些新的功能和特性,如国际化、日志打印、华为云接口封装等。 利用设计模式重构通知模块,提升代码质量,同时系统扩展性和并发也得到很大的提升。 3、个人发展方面的成果: 通过不断学习和实践,提高了自己的沟通能力和时间管理的能力。每天早上 7 点到公司学习,提高了个人工作效率和执行力。 4、团队合作方面的成果: 加强了和同事之间的沟通和协作,及时讨论项目需求和进度,保障项目按时上线。 读书 健身 我跑过了一些地方,希望随着时间推移,地图点亮的地方越来越多。2 年里我跑过 2 个省份 2 个城市。更多跑步数据在我的 跑步 主页。 理财 这周总计支出 1483 元,明细如下: 7 月 2 日:1276 元,其中 1000 元加油 7 月 1 日:32 元 6 月 30 日:35 元 6 月 29 日:15 元 6 月 28 日:41 元...

周报-25|端午安康

前言 本篇是对 2023-06-19 到 2023-06-25 这周生活的记录与思考。首发在我的个人 博客,你可以移步了解更多或者给我留言。 读书、健身、投资、帮朋友、陪家人。 这周因为端午节,只上三天班,放三天假。祝愿所有父母端午安康! 读书 本周阅读时长 15 分钟,主要是阅读《Java 高并发核心编程:多线程、锁、JVM、JUC、高并发设计模式》。 健身 我跑过了一些地方,希望随着时间推移,地图点亮的地方越来越多。2 年里我跑过 2 个省份 2 个城市。更多跑步数据在我的 跑步 主页。 本周尚未跑步。最近上班没有带饭,每天中午吃饭都超标了,每天也没有测量体重,严重怀疑体重又涨了几斤。这个月也快结束了,下个月继续减肥。 理财 这周总计支出 1027 元,明细如下: 6 月 25 日:30 元 6 月 24 日:133 元 6 月 23 日:462 元 6 月 22 日:69 元 6 月 21 日:147 元 6 月 20 日:159 元 6 月 19 日:27 元 陪家人 农历 5 月 4 日,六舅走了。端午节的三天假期,主要是回去奔丧,送六舅最后一程。 算了下日子,老爸来阳逻快一个月了,老婆放下手上的工作回来照顾老爸也有两周时间了。看得出来,老婆有效疲惫了。老爸现在可以走,但是走的不够利索。希望老爸恢复得再快些,让老婆回去上班。如有可能,下周末把老爸送回老家,让老爸自己在家照顾自己。农村的空气好些,不会憋得慌。但还是担心天气太热,老爸照顾不好自己。在照顾老爸的事情,除了能够依靠老婆,其他谁都靠不上。但是,老婆也有工作要处理,我的工作又不能辞掉。这大抵算是八零后的压力吧,父亲在买房买车结婚上没有帮上忙,反而还会因为自己不好好照顾自己而给子女增加负担。总是跟老爸说这该做那不该做,老爸就像个孩子似的,一点都不听话。 周六,在黄石开牙医院的表哥的女儿考上墨尔本的研究生在老家办酒。也许是上了年纪的缘故,也许是老爸喜欢凑热闹,老爸想去喝酒。于是,成全了老爸的心愿。老爸年纪大了,尽可能的满足老爸的一些想法和心愿,尽可能的带老爸体验"新鲜"的事物,比如,看电影,旅游。于是,周四带老爸去看了电影《消失的她》。还有什么事情可以做呢?这样一想,老爸年纪越来越大了,腿脚越来越不利索,能够做的事情越来越少了。趁光阴还在,多陪陪父母,常回家看看。 工作 最近在学习的内容清单: Effective Java(第 3 版) Java Design Patterns (中文) Real Python 本周完成五篇博客: [译]微服务设计模式 Java 设计模式:Aggregator Microservices Python 学习 5:函数 [译]Python 模块和包-简介 [译]用 Bottle 开发 本周分享 大部分有意思的内容会分享在 『ChenSoul Share』Telegram 频道或者我的 Memos 中。我写了一个 Python 脚本从 Memos 读取最近一周带有 #memos 标签的记录,分享到这里。...

周报-24|如果没有疼痛

前言 本篇是对 2023-06-12 到 2023-06-18 这周生活的记录与思考。首发在我的个人 博客,你可以移步了解更多或者给我留言。 读书、健身、投资、帮朋友、陪家人。 读书 本周尚未读书。 健身 我跑过了一些地方,希望随着时间推移,地图点亮的地方越来越多。2 年里我跑过 2 个省份 2 个城市。更多跑步数据在我的 跑步 主页。 本周尚未跑步。 理财 这周总计支出 1264 元,明细如下: 6 月 18 日:338 元 6 月 17 日:508 元 6 月 16 日:262 元 6 月 15 日:27 元 6 月 14 日:41 元 6 月 13 日:40 元 6 月 12 日:48 元 陪家人 本周因为老爸出院后需要人照料,所以我每天早晚往返于家(阳逻)和公司(光谷)之间。每天早上五点多就醒了,然后煮粥、招呼老爸吃饭喝药,六点半出门开车走三环去上班。这周请婶娘白天帮忙照顾老爸,主要是中午和晚上老爸要吃饭和喝药。我早上出门晚、晚上下班回来再照顾老爸。老爸胃溃疡,需要修养一个多月,另外最近痛风发作,身体多处关节疼痛。因为吃西药和打针都会伤胃,所以只能吃中药。中药见效慢,需要时间。而婶娘身上也有病,不能长期照顾,如果老爸这周痛风不能恢复,那下周只能老婆放下手上工作回来照顾老爸。老婆工作也是非常忙碌,也不能照顾太久,估计也就一个星期。如果过了一个星期,老爸还是不能恢复、不能生活自理,真不知道该怎么办了!很久之前就想到老爸可能会成为我的负担,影响我的工作,没有想到会来的这么快。有时候想抱怨,但抱怨有什么用?面对眼前的这一切,只能迎难面对。造成眼前这样的现状,我自己有一部分责任。都只怪我平时没有关心老爸,没有叮嘱老爸不要喝酒,在老爸身边陪伴的时间太少了。 周六去给岳父岳母送端午节,周日回去看望癌症转移到全身的六舅。六舅是乳腺癌,在经历了去年新冠疫情之后,癌细胞转移到肺部。年后没有引起足够的重视,直到痛的不行的时候才去医院做手术,错过了最佳治疗时机。上一次见到六舅还是四月份的时候,我开车带老婆一起回去看望老爸。那时候六舅还在菜园里面朝黄土背朝天,六舅给了我一些莴笋、包菜,老婆给六舅 3 百块钱,六舅硬是不要,拉扯了半天。走之前,六舅还叫何舅塞了 20 多个鸡蛋给我们。这次,再见六舅,六舅躺在床上全身疼痛,只能吃些流食,意识模糊,知道谁来看望她,却不能说话。每次开车上下班的时候,想起六舅这样子,心里就很难受,眼泪直打转。面对生老病死,成年人的崩溃只在一瞬间。昨日还在你面前混蹦乱跳的人,明天可能就不在了。为了不留遗憾,要善待身边的每一位亲人,常回家看看。感谢老婆总是提醒我要回家看望老爸,正是因为这个,每次回家看望老爸的时候,我都会去看下六舅。 如果没有疼痛,老爸和六舅就不会痛苦了,身边的人也就不会心痛。 工作 最近在学习的内容清单: Effective Java(第 3 版) Java Design Patterns (中文) Real Python 本周完成四篇博客: [译]为恐龙解释现代 CSS [译]为恐龙解释现代 HTML [译]为恐龙解释现代 JavaScript 《Effective Java 3》笔记 15:尽量减少类和成员的可访问性 本周分享 大部分有意思的内容会分享在 『ChenSoul Share』Telegram 频道或者我的 Memos 中。我写了一个 Python 脚本从 Memos 读取最近一周带有 #memos 标签的记录,分享到这里。...

周报-23|读书、健身、定投、帮朋友、陪家人

前言 本篇是对 2023-06-05 到 2023-06-11 这周生活的记录与思考。首发在我的个人 博客,你可以移步了解更多或者给我留言。 读书、健身、投资、帮朋友、陪家人。 以后周报的主题,会包括这几个部分:读书、健身、投资、帮朋友、陪家人,再加上工作和本周分享两块内容。 读书 本周阅读统计,总计阅读 31 分钟: 本周阅读摘抄: 人是周围 6 个人的平均值,如果你身边没有特别出色的年轻人与你为伍,你就找先贤们的书籍,他们把一生的所有思考、智慧、经历和情感,都倾注在那些书里头了。 如果有一天跟你共鸣的,全都是古往今来、古今中外那些最智慧、最深刻、最敏锐、最丰富、最博学的大脑,你大概率不会太差,你的精神世界也大概率会非常丰富。 “we are all in the gutter ,but some of us are looking at stars。” 这句话来自一个爱尔兰的诗人,叫做奥斯卡·王尔德:“我们都身处在阴沟里,但总有人仰望星空。” “ Three passions, simple but overwhelmingly strong, have governed my life: the longing for love, the search for knowledge, and unbearable pity for the suffering of mankind. ” 这是来自于罗素的一个演讲,叫做《我为什么而活着》,意思是:对知识的渴望,对爱情的追求,对人类苦难难以遏制的同情心,这三种简单而强烈的激情,苦苦支配我的一生 健身 我跑过了一些地方,希望随着时间推移,地图点亮的地方越来越多。2 年里我跑过 2 个省份 2 个城市。更多跑步数据在我的 跑步 主页。 这周因为父亲住院需要照顾他,所以跑步暂停。 理财 这周总计支出 5006 元,明细如下: 6 月 11 日:4057 元,父亲出院支付 3475 元 6 月 10 日:108 元 6 月 9 日:86 元 6 月 8 日:367 元 6 月 7 日:179 元...

周报-22|微信读书笔记助手

前言 本篇是对 2023-05-29 到 2023-06-04 这周生活的记录与思考。首发在我的个人 博客,你可以移步了解更多或者给我留言。 读书、健身、定投、帮朋友、陪家人,本周周报增加一块内容:读书,记录每周读书的时间。 微信读书笔记助手 最近注销了微信阅读账号,清空了历史数据。本着宁缺毋滥的原则,书架重新添加了几本书。计划是重新使用微信阅读养成读书的习惯。 在 chrome 浏览器添加了一个插件 微信读书笔记助手 ,可以将读书笔记一键导出为 markdown 格式。 导出的内容标注是一个标注一个段落,段落之间有一个换行。段落后面可以添加自己的思考(比如,用红色标注颜色)。 读书 本周阅读统计(图片来自微信阅读 app 分享): 理财 这周总计支出 2528 元,明细如下: 6 月 4 日:138 元 6 月 3 日:1650 元,医院看病 1600 6 月 2 日:61 元 6 月 1 日:0 元 5 月 31 日:108 元 5 月 30 日:625 元,公司停车场费用 600 5 月 29 日:41 元 健身 我跑过了一些地方,希望随着时间推移,地图点亮的地方越来越多。2 年里我跑过 2 个省份 2 个城市。更多跑步数据在我的 跑步 主页。 本周跑步 42.66 公里,最长跑步距离为 9.2 公里。 明细数据如下: 在朋友圈发了一个 5 月跑步 500 公里动态,一个高中同学建议我不要过度跑步,最好是跑步一天休息一天,以免伤了膝盖。受他影响,受他影响,6 月 1 日没有跑步,6 月 3 日和 4 日,带老爸去医院做检查,所以没有跑步。照此看来,6 月连续跑步 30 天、累计 200 公里的目标铁定是完成不了,所以及时调整目标和计划,还是以长期主义的思路保持跑步的习惯,不求数量。 工作 最近在学习的内容清单: Effective Java(第 3 版) Java Design Patterns (中文) Real Python 本周完成四篇博客:...

周报-21|Python之禅、产品经理被优化、端午节送节

前言 公司价值观 本篇是对 2023-05-22 到 2023-05-28 这周生活的记录与思考。首发在我的个人 博客,你可以移步了解更多或者给我留言。 周一,休产假的产品经理回来上班,得知她被优化之后,内心有些不舍和伤感。中午,组长请大家一起吃了饭。晚上,产品经理交割完办公用户之后,就没来上班了。自此,过完年后,公司至少有三位女同事修完产假之后就离职了,有的是主动,更多的应该是被动。虽然有 N+1 赔偿,但是,这个社会对女性还是不够公平。 还有 3 个月就要到端午节,老婆买了粽叶包粽子,我也动手包了一部分。虽然包的不好看,但心里还是很满足的。自己包的粽子送节,显然更有意义。结婚之后的第一个端午节,周末开车去给长辈送了端午节。看着长辈们的头发日渐斑白,不禁感叹岁月无情。趁着年轻的时候,要对身边的亲人好一些。不要等到来不及了才知道后悔。 这周在 docker 里部署了 Plausible ,使用过程中发现 Plausible 架构过于复杂,使用了 postgres 和 clickhouse 数据库,docker-compose 启动了 4 个容器,所以最后还是放弃了使用 Plausible。umami 的 postgres 数据库只包括几张表,操作起来比较容易,比如:时不时地,我会把来自 localhost 的访问记录删除掉,这样统计数据更加真实准确。 Python 之禅 这是最近的一个 PyTricks:在 python REPL 里面输入 import this 会输出 The Zen of Python, by Tim Peters: 英文: The Zen of Python, by Tim Peters Beautiful is better than ugly. Explicit is better than implicit. Simple is better than complex. Complex is better than complicated. Flat is better than nested. Sparse is better than dense. Readability counts. Special cases aren’t special enough to break the rules....

周报-20|自动生成每日早报、周末团建

前言 乐农湖畔生态园 本篇是对 2023-05-15 到 2023-05-21 这周生活的记录与思考。首发在我的个人 博客,你可以移步了解更多或者给我留言。 不知不觉,这已经是第 20 篇周报了。这周依旧是健身、理财、学习和写博客。 自动生成每日早报 最近在朋友圈看到这样一个早报,就在想能否通过代码自动抓取新闻并生成这样一个早报图片? 于是,在网上找到一篇文章:前后端均基于 vercel 的每日早报项目 参考源代码,做了一些修改,代码见:fetch_news.py。修改后的逻辑是将抓取的新闻发送到 memos,例如:https://memos.chensoul.com/m/349 。可以在 github action 设置每天早上 7 点自动发送到 memos,然后再通过 n8n 同步到 『ChenSoul Share』Telegram 频道。 在 memos 中导出的图片如下: 如果能够通过 python 自动生成图片,那就更好了。记录一下,待以后实现。 团建 公司团建选择在周六,而且还是 520 这一天,真是会挑日子。很多人请假,最后只有 13 人参加团建,其中有 8 人是我们开发组的 🤣。挑两张照片发到这里~ 理财 这周总计支出 1861 元,明细如下: 5 月 15 日:1027 元,武功山旅游,加油 327 5 月 16 日:42 元 5 月 17 日:12 元 5 月 18 日:16 元 5 月 19 日:25 元 5 月 20 日:562 元,看望六舅 5 月 21 日:177 元 健身 本周跑步 36 公里,最长跑步距离为 10 公里。明细数据如下: 我跑过了一些地方,希望随着时间推移,地图点亮的地方越来越多。2 年里我跑过 2 个省份 2 个城市。更多跑步数据在跑步主页。 工作 博客 本周完成五篇博客:...

周报-19|武功山看日出、Python初学建议

前言 本篇是对 2023-05-08 到 2023-05-14 这周生活的记录与思考。首发在我的个人 博客,你可以移步了解更多或者给我留言。 本周继续学习 python,发现一个质量非常高的 python 学习网站 Real Python,该网站有学习 python 的一些教程,是收费的,部分章节是可以免费观看的。 另外,周五晚上老婆临时起意想去武功山看日出,于是立即规划行程并购买火车票。因为一年半之前,我去过一次,所以规划起来还是很轻松的。上一次去是国庆节碰到下雨,没有看到日出。幸运的是,这次是晴天,不仅看到了日落还看到了日出。这一次没有选择住帐篷,而是住在了云中雾客栈,没想到这个客栈离金顶需要 40 分钟左右的路程,而且有段路程是坑坑洼洼。 去武功山之前,先去了长沙,再次游了橘子洲头,并第一次在长沙跑步打卡。本想在萍乡也跑步打卡,奈何没有得逞。 这次去了长沙和武功山,下次基本上是再也不会去爬武功山了。长沙还会去,因为从武功山回来路上,就和老婆规划着什么时候去张家界。 武功山看日出 理财 这周总计支出 1784 元,明细如下: 5 月 8 日:12 元 5 月 9 日:18 元 5 月 10 日:200 元 5 月 11 日:12 元 5 月 12 日:445 元 5 月 13 日:662 元 5 月 14 日:435 元 因为周末出去旅游,所以本周支出有所增多。 健身 本周跑步 56 公里,最长跑步距离为 13 公里。 明细数据如下: 周末出去旅游,路过长沙,在长沙跑了两天,累计跑了 6 公里。这样,我的跑步数据 从 2 年里我跑过 1 个省份 1 个城市 变成了 2 年里我跑过 2 个省份 2 个城市。 工作 Java 博客 本周完成两篇博客 《Effective Java 3》笔记 10:覆盖 equals 方法时应遵守的约定 JSR 166 规范 Python Python 初学建议 1、新手如何学习 python?...

周报-18|导出豆瓣数据、Effective Java 3第二章总结

前言 本篇是对 2023-05-01 到 2023-05-07 这周生活的记录与思考。首发在我的个人 博客,你可以移步了解更多或者给我留言。 继上周实现导出苹果接口数据之后,这周又实现了自动导出豆瓣数据。此外,还萌生了导出每天阅读的数据的想法。奈何现在阅读 app 都需要收费,只能暂且搁置这个想法。 最近在学习 Python,于是将学习中做的笔记发布到了博客,这周发布了两篇文章,希望通过输出来倒逼输入,以此来快速掌握 python 编程并能开发一些项目。另外,计划在学完之后,继续学习 Rust 和 Go,甚至开始学习前端开发。 最近又一次更换了博客主题,主要出发点是想找一个简洁的主题,减少不必要的信息干扰,也不想花时间在修改主题上面。减少了菜单链接。 导出豆瓣数据 最近阅读了一篇文章 很认真的在考虑不再使用豆瓣这件事 ,于是使用 lizheming/doumark-action 导出豆瓣数据。 在我的 github 主页 https://github.com/chensoul/chensoul 创建一个 workflow douban.yml ,每隔一个小时同步一次豆瓣数据(读书、电影、音乐)到 csv 文件。拿到这些文件之后,就可以通过 html + css 渲染出来,类似这个页面 书影音。等豆瓣数据增多之后,再考虑实现这个。 除此之外,之前还实现了通过 n8n 实时同步豆瓣数据到 memos 和 telegram: 通过 python 脚本 获取最近 10 条记录,显示到 我的 github 主页。 理财 这周总计支出 816 元,明细如下: 5 月 1 日:55 元 5 月 2 日:79 元 5 月 3 日:370 元,其中 270 元加油 5 月 4 日:136 元,其中捐款 50 元 5 月 5 日:12 元 5 月 6 日:100 元,手机话费充值 5 月 7 日:64 元 最近一直想统计一下工作和生活中的固定支出费用,于是今天花了点时间做了统计。没想到每年工作和生活中固定支出费用竟然达到了 1529+6180=7709 元。其中大块头是手机话费和停车位费用,手机话费是因为办理一个电信套餐送宽带和一部手机;停车位费用是因为今年买了车。...