Loading...

checklist

Created2018-10-26|Updated2026-10-10|工程实践

|Word Count:116|Reading Time:1mins|Post Views:

写代码 checklist

注意位置
注意顺序
注意初始化
注意返回值
注意注释
注意防御性编程
注意数据库性能

上线 checklist

代码变更 check 代码
配置变更 check 配置
系统变更注意上线顺序
依赖中间件变更注意配置中间件
配置中心配了吗
交互所有细节都实现了吗？
配监控和埋点
数据库变更了吗？
安全检查

Author: magicliang

Link: https://magicliang.github.io/2018/10/26/checklist/

Copyright Notice: All articles on this blog are licensed under CC BY-NC-SA 4.0 unless otherwise stated.

Related Articles

软件设计，必有单元/片段，不管他们叫做系统、层次、模块、类型和方法，都是为了在一个抽象颗粒度上分割复杂度，让我们降低思考的难度，并且进行团队协作。我们在进行系统交互的时候，要尽量设计单元交叉点通过薄的中间层交互。也就是放弃直接性，拥抱间接性。间接性的实现，就是契约、接口或者门面/桥接模式。这些实践的使用，可以轻易让我们切换层次之间的实现，而使变动不扩散出去。

变更日志（Changelog）规范

什么是变更日志变更日志（Changelog）是一个按时间顺序记录项目所有重要变更的文件。它帮助用户、开发者和利益相关者了解每个版本中发生了什么变化，包括新功能、Bug 修复、破坏性变更等。为什么需要变更日志用户友好：让用户快速了解新功能、修复的问题和需要注意的变更版本追溯：帮助定位问题首次出现或修复的版本团队协作：统一团队对变更的理解和沟通发布管理：辅助版本发布流程和发布说明的撰写与 Git Log 的区别特性变更日志 Git Log 目标受众用户、开发者、利益相关者开发者内容粒度功能级别的高级描述每次提交的详细记录可读性高度结构化、易于阅读技术性强、包含实现细节维护方式手动维护或自动化生成自动记录所有提交版本关联按版本组织按时间顺序 Git Log 记录所有的代码提交，包括内部重构、测试调整等；而变更日志只记录对用户有意义的变更。 Keep a Changelog 规范 Keep a Changelog 是目前最广泛采用的变更日志规范，由 Olivier Lacan 创建。变更类型分类 Ke...

CI/CD 方法论的前世今生

软件工程有一条反直觉的规律：集成的频率越高，每次集成的痛苦越小。这条规律从 1990 年代末被 Kent Beck 写进极限编程的实践清单，到今天演化出一整套涵盖构建、测试、部署、发布的自动化体系。CI/CD 不是某一个工具或某一种流程，而是三十年工程实践反复迭代的产物。持续集成的诞生（1996-2006）极限编程与 CI 的起源 1996 年，Kent Beck 加入克莱斯勒公司的 C3（Chrysler Comprehensive Compensation System）项目。这个项目此前陷入僵局，Beck 将它作为极限编程（XP）的试验田，引入了十二条核心实践，持续集成是其中之一。CI 的核心主张很简单：开发者每天多次将代码集成到主干，每次集成都触发自动构建和测试。1999 年出版的《Extreme Programming Explained: Embrace Change》正式将 CI 确立为一个命名实践。 CI 要解决的问题在当时有一个形象的说法叫"集成地狱"（integration hell）——团队各自开发数周甚至数月，最后合并代码时发现冲突...

Agent Teams 为什么有效

多 Agent 不是把同一个模型多开几份，也不是给系统加几个“人格”。它有效的地方，是把一个会互相稀释的上下文问题，拆成几个更窄、更干净、更容易验证的工作单元。复杂任务不是信息越多越好。一个 Agent 同时负责需求、架构、编码、测试、文档和发布，很容易在同一个窗口里把角色、证据和目标搅在一起。Agent Teams 的价值，是让每个工作单元只面对一个足够小的世界。注意力需要降维考虑一个频谱分析的类比：复杂任务像一段混合信号，包含多个频率分量叠加。单 Agent 试图同时处理所有频率，相当于用一个宽带滤波器——信噪比低，各分量互相干扰。多 Agent 相当于用一组窄带滤波器，每个只提取自己负责的频段，互不干扰，最后再合成输出。模型的注意力也有这个问题。任务越大，上下文里越容易同时出现目标、反例、日志、旧方案、失败尝试、代码片段和用户补充。它们都在争夺同一个窗口里的注意力。多 Agent 的第一层收益，就是把同一团上下文切成几个局部上下文。阶段拆分让角色线性化第一种降维是阶段拆分。Plan 阶段只决定做什么，不写代码；Build 阶段只实现已确定的任务，不重新发明...

第 1 章欢迎进入软件构建的世界第 2 章用隐喻来更充分地理解软件开发第 3 章三思而后行：前期准备第 4 章关键的“构建决策” 第 5 章软件构建中的设计第 6 章可以工作的类第 7 章高质量的子程序第 8 章防御式编程第 9 章伪代码编程过程第 10 章使用变量的一般事项第 11 章变量名的力量第 12 章基本数据类型第 13 章不常见的数据类型第 14 章组织直线型代码第 15 章使用条件语句第 16 章控制循环第 17 章不常见的控制结构第 18 章表驱动法第 19 章一般控制问题第 20 章软件质量概述第 21 章协同构建第 22 章开发者测试第 23 章调试第 24 章重构第 25 章代码调整策略第 26 章代码调整技术第 27 章程序规模对构建的影响第 28 章管理构建第 29 章集成第 30 章编程工具第 31 章布局与风格第 32 章自说明代码第 33 章个人性格第 34 章软件工艺的话题第 35 章何处有更多的信息

Harness Engineering 完整指南：从 Prompt Engineering 到实践落地的三级跃迁

2020 年我们学会了跟模型说话（Prompt Engineering），2025 年我们学会了给模型喂信息（Context Engineering），2026 年我们学会了给模型搭脚手架（Harness Engineering）。这三个 Engineering 不是并列关系，而是严格的超集关系：PE ⊂ CE ⊂ HE。本文从"为什么上一个不够"的视角，系统梳理这条演进路径上的每一次范式跃迁，并给出从 Anthropic 实证到工程落地的完整方案。一个类比秒懂三级跃迁在讲技术之前，先用一个所有人都能理解的类比。想象你要指挥一个完全失忆的天才厨师做一桌满汉全席： Prompt Engineering 就是学会怎么跟厨师下达指令。你发现说"做道好吃的"不行，得说"用中火煎三分钟，翻面后加酱油 15 毫升"。这是措辞的艺术。 Context Engineering 就是学会怎么给厨师备料。光会下指令不够——厨师面前得摆好食材、调料、菜谱、食客的过敏信息。你要设计一个动态备料系统，让厨师在需要的时候拿到需要的东西...

Loading Database