CanWay工作日志
日报引擎
这是一个基于mkdocs+自研日报引擎的CMS(内容分发系统),相较于erp系统等,可以更详细细致的记录自己的工作列表,方便进行工作总结与回顾。引擎提供了一个日报模板,方便导出邮件格式发送。预览地址:(http://10.10.41.235:8001/)
📝目录导航¶
一、前言¶
你是否有过这样的疑虑/困惑/需求:
- ERP不能满足日常工作的需求
- workflow的优化需求
- 很多天后,不知何时 你很久以前的项目需要缺陷修复或者项目对接,而你已经忘得一干二净
- 在处理多个项目时遇到的类似问题,常常困扰许久却因为没有记录,造成了每次解决问题都需要花费很长时间
- 在工作中发现需要总结提升的地方,记录自己的小idea
- 当领导跟你要的内容,你要快速回忆并且输出(特别是过了一个周末,可能你什么都忘了,但是你的工作日报记得,可以让你快速call back)
在经过7天+的工作流优化后,摸索出的一套逻辑清晰的工作流处理方式(含本地+云端同步处理方式)。为了更加长期且高效的工作环境,编写系统如下:
一般自己的工作流输出分为三种情况:
- 【todo/idea类型】临机一动的想法,包括业务中发现的bug、工作流优化的思考idea等等,含被同时临时提的MR请求,git pull请求记录
- 【readme类型】处理某项目时 攥写的项目文档,可能会因项目不同攥写几天(如动态表单),也可能是一个工作交接文档
- 【report类型】一个或短或长的工作日报,方便填写erp等
此时如何分类就成了一个难题,以时间/项目类型都无法完全覆盖工作的使用场景,同时记载一个地方又会导致记录很乱。
二、概述¶
欢迎访问邓仕昊 (id:sx_dancehole)的实习工作日报站点(下面简称CanLab)。出于安全考虑,本站点仅供嘉为员工使用内网访问,在非工作时间站点服务将会关闭。
本系统基于mkdocs+自研日报引擎实现,点击这里查看项目介绍,具体实现:
- 自动填写并提交erp日报(todo:根据今天日报填充标题和内容)
- 自动创建并维护日报目录(每天只需要往正文里填入内容)【亮点:支持归档,小idea的记录】
- 根据日报模板生成周报,周报会包含日报的所有链接
- 通过web发布/支持基于对象存储/githubpage的静态页面,支持使用nodejs构建服务,支持内网或公网访问(代理+穿透),会以CMS形式发布(类似于xx文档)支持分类,多级目录和标题,支持全局搜索和自定义页面
CanLab包含工作中经常使用的文档和参考,同时记录了实习过程中的问题记录与解决,包含erp的实习日报等。
本系统包含了三个子系统,包含:
- autoHandleERP:自动处理日报,自动提交erp日报
- edge插件
- dailyReportHandler:自研日报引擎
- 自研python包,目前已经发布
- mkdocs:轻量级CMS引擎,用于打包构建与发布
- 开源python包,目前使用第三方material
三、快速开始¶
💿发行版下载¶
autoHandleERP
dailyReportHandler
- 内网下载地址
- Github Release
- Source Code
- pypi/pip
- 命令行安装:
pip install dailyReportHandler
mkdocs
✅运行环境¶
python>=3.6.8+
⬇️使用方法¶
新建日报
daily
默认在目录行调用目录下,创建本日日报
-d mm-dd
指定日期-p D:/docs/..
指定绝对路径
部署web服务
mkdocs init
mkdocs serve
-a ip:port
指定端口号
erp系统
- 打开公司erp网站并登录
- 在注入的半透明窗口上,选择填写的日报信息
四、安装与使用说明¶
需要注意的问题:
- ip等信息是一次性生成,不能动态起后端服务(没有操作数据库),所以建议固定ip
五、功能说明¶
ps:该工作流完美适配实习提交周记和总结的需求(dailyReportHandler)
六、工作日志¶
日期 | 工作主要内容 | 所在项目/分类 | 文章输出 |
---|---|---|---|
第一周 | |||
04-24 | 入职第一天 【数字广东定制开发】 |
非产品线纯定制开发 | 04 24 入职第一天 - 邓仕昊的工作日志 |
04-25 | 代码环境拉取&工作流 Vscode插件,Eslint代码规范 |
非产品线纯定制开发 | 04 25 - 邓仕昊的工作日志 |
04-26 | 新需求:AD密码修改完成 公司知识库 |
非产品线纯定制开发 | 04 26 - 邓仕昊的工作日志 |
04-29 | 工作流优化 定制开发-线上测试 |
非产品线纯定制开发 | 04 29 - 邓仕昊的工作日志 |
04-30 | 需求:RSA加密修改+样式修改 | 非产品线纯定制开发 | 04 30 - 邓仕昊的工作日志 |
密码安全 | 文章输出 | 基于Edge的密码本强度分析工具 | |
第二周 | Week2周报 - 邓仕昊的工作日志 | ||
05-06 | bugfix-登录页面的样式修改 cmp分支拉取,接触新业务 |
非产品线纯定制开发 | 0506-bugfix - 邓仕昊的工作日志 |
05-07 | 梓越讲解动态表单,4.8分支拉取-动态表单研究 | [R]多云管理平台 | 工作日报 - 邓仕昊的工作日志 |
05-08 | 动态表单测试 众邦银行项目-原型设计 |
[M]众邦银行 | 工作日报 - 邓仕昊的工作日志 |
05-09 | 虚拟机新增 | [M]众邦银行 | 0509 - 邓仕昊的工作日志 |
05-10 | 动态表单文档 | [M]众邦银行 | 动态表单攥写指南 - 邓仕昊的工作日志 |
05-11 | 虚拟机变配【todo】 | [M]众邦银行 | |
第三周 | |||
05-06 | bugfix-登录页面的样式修改 cmp分支拉取,接触新业务 |
非产品线定制开发、数字广东2023~2024统一门户建设项目 | 05-06-邓仕昊的工作日报 |
05-07 | 梓越讲解动态表单,4.8分支拉取-动态表单研究 | [R]多云管理平台 | 05-07-邓仕昊的工作日报 |
05-08 | 动态表单测试 众邦银行项目-原型设计 |
[M]众邦银行 | 05-08-邓仕昊的工作日报 |
05-09 | 虚拟机新增 | [M]众邦银行 | 05-09-邓仕昊的工作日报 |
05-10 | 动态表单文档 | [M]众邦银行 | 05-10-邓仕昊的工作日报 |
05-11 | 虚拟机变配【todo】 | [M]众邦银行 | |
第四周 | |||
05-13 | [需求1-3]虚拟机新增 | [M]众邦银行 | 05-13-邓仕昊的工作日报 |
05-14 | [需求4]新建块存储 | [M]众邦银行 | 05-14-邓仕昊的工作日报 |
05-15 | [需求5-8]虚拟机变配 | [M]众邦银行 | 05-15-邓仕昊的工作日报 |
05-16 | [需求9]生命周期管理 | [M]众邦银行 | 05-16-邓仕昊的工作日报 |
05-17 | 联调+加班 | [M]众邦银行 | [05-17-邓仕昊的工作日报]( |
第五周 | |||
05-20 | 整理青云接口+依赖关系+接口测试联调;EasyStack的接口 | [M]众邦银行 | 05-20-邓仕昊的工作日报 |
05-21 | 完成青云接口移植 | [M]众邦银行 | 05-21-邓仕昊的工作日报 |
05-22 | 修bug | [M]众邦银行 | 05-22-邓仕昊的工作日报 |
05-23 | 修bug | [M]众邦银行 | 05-23-邓仕昊的工作日报 |
05-24 | 修bug | [M]众邦银行 | 05-24-邓仕昊的工作日报 |
众邦银行终于收尾了,总体来说这个项目代码量不大但是需要自己配置动态表单,非常的麻烦。有时候遇到问题还不得已去改动态表单模块的实现代码,完全违反了面向对象的特性。不过也没办法了,就这样吧。 | |||
第六周 | |||
05-27 | 众邦的收尾和bug的被动修复;接到新fix,缺陷修复ITR单: - INC20240105000001 IP管理SaaS编辑IP池保存报错 - INC20240506000007【太平金科】SSL证书监控--无法新增用户 又接到了个。很难调试的活 梳理了工单解决的流程 |
ITR缺陷修复 | 05-27-邓仕昊的工作日报 |
05-28 | IP管理SaaS编辑IP池保存报错 【太平金科】SSL证书监控--无法新增用户 |
ITR缺陷修复 | 05-28-邓仕昊的工作日报 |
05-29 | 同上,确认首要问题是csrf_token的问题,因为api在浏览器调试没有问题: | ITR缺陷修复 | 05-29-邓仕昊的工作日报 |
05-30 | ip地址池管理的缺陷修复(ip地址池) | ITR缺陷修复 | 05-30-邓仕昊的工作日报 |
05-31 | IP管理:新增或者修改地址池保存时报空错误,经确认是因为线上接口和本地远程接口字段不一致导致的,登录远程环境才发现 ssl证书监控:新增用户的列表 没有展示中文名和手机号 |
ITR缺陷修复 | [05-31-邓仕昊的工作日报]( |
第七周 | |||
06-03 | SSL证书监控(模板引擎,仍有字段问题) 数字广东前期工作总结(因为是模板引擎+github,没有仓库做版本管理控制) |
ITR缺陷修复 | 06-03-邓仕昊的工作日报 |
06-04 | daily引擎的完善 | \ | 06-04-邓仕昊的工作日报 |
06-05 | autoCompleteCW插件优化:增加可选条件 因为数字广东涉及到登录页的修改,第二次遇到无法调试的问题了,于是痛定思痛下定决定要把后端服务给跑起来,这样才可以实时观察模板引擎生成的登录页的效果(结果还是没运行起来) 新需求:数字广东AD密码修改 |
[定开]数字广东网络建设-统一门户维保 | 06-05-邓仕昊的工作日报 |
06-06 | 每次调试 都要手动打包为.min.js文件(模板内容) | [定开]数字广东网络建设-统一门户维保 | 06-06-邓仕昊的工作日报 |
06-07 | 修改一下接口,今天提交一版: 狠狠的加班到九点 |
[定开]数字广东网络建设-统一门户维保 | 06-07-邓仕昊的工作日报 |
数字广东项目修改也算结束了,总的来说时一个很奇葩的项目(模板引擎,很难调试),不过也更加清楚运维人员需要更加了解前后端和整体的架构,总体来说因为是纯html+js+模板项目,前端的难度并不算太大,卡点较少(相对后面来说) | |||
第八周 | |||
06-11 | 增加修改验证码+倒计时 缺陷修复,等收尾工作 |
[定开]数字广东网络建设-统一门户维保 | 06-11-邓仕昊的工作日报 |
06-12 | 接入新项目“云南电信”: 云南电信-作业计划移动端问题 新需求开发: 周期指定与周期循环名称互换 周期任务新增或修改时,增加【类别】【作业项】的下拉框,二者是级联关系。 点进任务详情时,要判断所属是否可更改,若可更改,需有下拉列表展示同组其它用户供选择。 用户管理页面,新增字段是否管理员。 |
[定开]数字广东网络建设-统一门户维保 [定开]中国电信股份有限公司云南分公司 |
06-12-邓仕昊的工作日报 |
06-13 | 整理需求 | [定开]中国电信股份有限公司云南分公司 | 06-13-邓仕昊的工作日报 |
06-14 | 修复循环任务等 总体来说是一些比较重复且难度不高的工作 |
[定开]中国电信股份有限公司云南分公司 | 06-14-邓仕昊的工作日报 |
第九周 | |||
06-17 | 完成云南电信内容,与后端最后联调修复 | [定开]中国电信股份有限公司云南分公司 | 06-17-邓仕昊的工作日报 |
06-18 | 新缺陷单(较为棘手) PBI20240530000001南方电网IT监控提单+IT资源管理 |
[定开]南方电网数字电网研究院有限公司 | 06-18-邓仕昊的工作日报 |
06-19 | [定开]南方电网数字电网研究院有限公司 | 06-19-邓仕昊的工作日报 | |
06-20 | IT监控的项目缺少依赖,难以推进 | [定开]南方电网数字电网研究院有限公司 | 06-20-邓仕昊的工作日报 |
06-21 | 完成IT资源管理(权限控制与全局收尾拦截) | [定开]南方电网数字电网研究院有限公司 | [06-21-邓仕昊的工作日报]( |
第十周 | |||
06-24 | 接到新需求:数字广东新saas开发、北京生态环境部需求补充 | [定开]数字广东网络建设有限公司 [定开]中华人民共和国生态环境部 |
06-24-邓仕昊的工作日报 |
06-25 | (优先处理)南方电网IT监控和IT资源管理-缺陷修复 (优先)北京生态环境部 |
[定开]中华人民共和国生态环境部 [定开]南方电网数字电网研究院有限公司 |
06-25-邓仕昊的工作日报 |
06-26 | (极度优先)北京生态环境部 工单的操作里,没有上传附件的可以有操作“上传附件”,上传了附件的可以“查看附件(实际就是直接下载附件)”;附件可以是多个文件、图片、类型不限 工单里编辑状态的时候,需要有“情况反馈、处理人、联系方式”这三个表单字段 |
[定开]中华人民共和国生态环境部 | 06-26-邓仕昊的工作日报 |
06-27 | feature: 新增工单支持传图片;可以上传附件;审核增加字段 Reapply "bugfix: 解决首页Maximum call stack size exceeded的问题(增加/根路由)" Reapply "feature: 新增工单支持上传附件" Reapply "feature: 新增下载和上传附件的接口" minor: 打包(修改前) bugfix: 修改路由、 |
[定开]中华人民共和国生态环境部 | 06-27-邓仕昊的工作日报 |
06-28 | minor: 创建的时候设置is_own为true minor: 删除跟路由重定向 bugfix: disable条件 bugfix: 修改下载 bugfix: 增加is_own字段 bugfix: 新增附件修改字段、 bugfix: 联调修改 feature: 新增工单支持传图片;可以上传附件;审核增加字段 Reapply "bugfix: 解决首页Maximum call stack size exceeded的问题(增加/根路由)" Reapply "feature: 新增工单支持上传附件" |
[定开]中华人民共和国生态环境部 | 06-28-邓仕昊的工作日报 |
七、贡献指南¶
欢迎您参与贡献,我们鼓励开发者以各种方式参与文档反馈和贡献。
您可以对现有文档进行评价、简单更改、反馈文档质量问题、贡献您的原创内容,详细请参考贡献文档。
当前缺陷记录:
- 无法正确写入周【dailyReport包问题】
- mkdocs-web网页的多级列表,首行空两格、换行、样式、math库、todo样式都有问题