软件工程
为新工程师创建代码库导览
面向新人的导览,从可运行路径开始,解释仓库边界和所有权,并安排逐步深入的代码阅读练习。
流程
按这个顺序做。
- 确定新工程师角色、第一个有用结果、时间盒、仓库修订、本地前置条件,以及导览要回答的问题。
- 从一个入口沿一条安全的正常路径追踪到测试或产物,记录命令、预期输出和最小有用变更。
- 绘制仓库主要目录、构建与部署边界、数据与外部系统、负责人、文档和关键决策。
- 创建逐步停留点,每点包含阅读问题、小练习、验证信号,以及在生产或有后果的访问前的明确停止点。
- 添加术语表、权威代码与决策链接、常见陷阱、升级联系人,以及私有或非公开证据的处理指导。
- 请同事或从干净环境进行自检来验证导览,修正不清楚的步骤,并记录无法测试的部分。
- 发布带版本的导览,附更新负责人、每条路径的证据、已知限制和给未来维护者的未解决风险。
先准备
猫会向你要的输入。
- 新工程师角色与第一个结果
- 仓库与本地设置说明
- 时间盒与学习限制
- 负责人与升级联系人
路由器 + 一份 playbook
先路由。只选一份。
Cat Paw 每次任务只加载一份 playbook,不合并多份。先走这个路由器;其余路径是此 workflow 可检查的候选。
- 路由器:
codebase-knowledge-pack skills/codebase-knowledge-pack/codebase-onboarding-tour/SKILL.md
界限
界限跟着提示一起走。
- 开始前核实实际工具、账号、权限和工作区;绝不声称拥有不可用的工具、账号、来源或能力。
- 私有代码、产物、实时探测或非公开数据使用 Latch/target-workspace;如果无法访问,就在边界停止并报告阻塞,不要用猜测替代。
- 任何有后果的外部行动前先暂停并取得明确批准;返回证据、未解决风险、假设以及仍等待批准的行动。
完成代表
一个可核对的终点。
带版本的新工程师导览把新人从已验证的可运行路径带到更深入的仓库知识,并记录所有权、练习、证据和未解决风险。
来源
这个流程从哪来。
- github.com/Egonex-AI/Understand-Anything/tree/6df3065f1d8ddc2ce3615314d1d493f36d6b1c80/
- c4model.com/
- docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners
来源确立 workflow 的模式。如有 Reddit 或社区帖子,视为实务轶事,不是普遍事实。