日志规范化 Skill 定制指南:改风格、改阈值、改输出格式
如果你在代码仓库与终端里反复做日志规范化,可以考虑把经验沉淀为一个 Skill:写清触发条件、步骤、输出格式和边界,让智能体代劳重复部分,人只负责把关。
通用版的「日志规范化」能覆盖大多数情况,但每个团队都有自己的习惯。下面列出最值得调整的几个地方。
可调参数一览
| 参数 | 默认 | 可以怎么改 |
|---|---|---|
| 输出格式 | 改造后的日志调用与规范说明 | 改成团队模板、表格或固定小标题 |
| 详略程度 | 适中 | 给领导看的精简版 / 给执行者看的详细版 |
| 语气风格 | 中性 | 按团队文风、对外或对内调整 |
| 严格程度 | 标注不确定项 | 提高到“任何推断都要给依据” |
| 步骤 | 4 步 | 增加团队特有的检查步骤 |
改写示例:description
通用版:
统一日志级别、字段与格式,补齐关键路径日志。当用户提到日志规范化时使用。
团队版(示意):
按本团队规范进行日志规范化:先读取 reference.md 中的模板与术语表,再处理服务代码。当团队成员提到日志规范化或上传相关材料时使用。
改写示例:增加团队步骤
## 步骤
1. 读取日志规范
2. 找出不一致调用
3. 统一字段
4. 在关键路径补日志并避免记录敏感信息
5. 对照 reference.md 中的团队检查表逐项确认
6. 按团队模板输出,并在开头写一句结论
按角色出多个版本
同一个技能可以为不同角色准备变体:新人版写得更细,并解释每一步的理由;熟手版只保留关键检查点。也可以在一个技能里用参数区分,例如“简版/详版”。
定制时别丢掉的东西
- 领域底线:改动前确认有测试与版本控制,一次只改一类问题
- 缺信息先提问
- 需人工确认清单
- 属于中等风险:结果会影响业务判断,建议在输出前设置人工审核点
每一步要产出什么
把每一步的中间产出写清楚,智能体就不容易跳步,人也方便定位问题:
- 读取日志规范:产出一段简短的中间结果,并注明依据来自服务代码的哪一部分
- 找出不一致调用:产出一段简短的中间结果,并注明依据来自服务代码的哪一部分
- 统一字段:产出一段简短的中间结果,并注明依据来自服务代码的哪一部分
- 在关键路径补日志并避免记录敏感信息:产出一段简短的中间结果,并注明依据来自服务代码的哪一部分
最后一步之后,再把这些中间结果汇总成改造后的日志调用与规范说明。中间结果可以折叠或省略展示,但在技能指令中要求智能体“先完成再汇总”,能明显减少遗漏。
领域注意事项
「日志规范化」属于代码质量领域,使用者多是开发者,工作环境通常是代码仓库与终端。这个领域最重要的一条底线是:改动前确认有测试与版本控制,一次只改一类问题。
建议把这条底线原样写进技能的约束部分,而不是指望智能体自己意识到。同时,在团队内部明确:智能体给出的改造后的日志调用与规范说明只是初稿或建议,最终由谁签字确认、出了问题由谁负责。
延伸阅读
- 日志规范化 · 极简与进阶
- 日志规范化 · 检查清单
- 日志规范化 · Gemini CLI 版
- 代码风格迁移 · 定制指南
- 代码归属梳理 · 定制指南
- 智能体Skills 分类:625 个技能 × 32 个角度
说明:文中的配置、代码与目录结构均为示意,用于说明思路;各平台的入口、字段名与能力会更新,落地前请以对应官方文档为准。示例中的数据与场景为虚构,不代表真实案例。