当用户完成一个项目功能、里程碑、调试会话、交付阶段或学习节点,并希望生成一份 Markdown 格式的复盘文档,用于后续学习、面试准备、简历中的故事化呈现或技术回顾时使用,尤其适用于……
总结工程里程碑是一项面向实际任务的技能,主要用于概览. 创建一个磨损的Markdown里程碑审查, 由当前对话, 本地代码上下文, diffs, 测试, 以及用户的指定目标。它将相关步骤、工具调用和结果整理方式集中到统一流程中,帮助使用者更快完成目标并减少重复操作。
实际使用前应先确认任务范围、数据来源、运行环境、必要权限和关键参数,再依据技能说明逐步执行;若输入条件不完整,应先补齐信息或采用保守配置,避免因错误假设导致结果偏离需求。
执行过程中需要关注工具调用是否成功、接口或依赖是否可用、输出格式是否符合预期,并对异常提示、缺失字段和边界情况进行处理;涉及批量任务时,还应保存进度,避免中断后重复操作。
基于当前对话、本地代码上下文、变更差异(diffs)、测试结果以及用户明确陈述的目标,生成一份专业、精炼的 Markdown 格式里程碑复盘文档。该文档需兼顾两大用途:便于日后快速回顾,以及满足技术面试中清晰讲述项目故事的需求。
当用户使用中文输入时,默认输出中文版本。所有技术标识符、CLI 命令、路径、代码符号等均保持原文不变。中文输出时,章节标题应自然翻译为符合中文技术文档习惯的表达,而非直译或保留英文标签。
YYYY-MM-DD-.md 。除非用户另行指定,否则统一采用以下结构:
# <标题> ## 一句话总结 ## 背景与目标 ## 已完成工作 ## 核心实现 ## 解决的关键难点 ## 优化点与权衡取舍 ## 关键代码索引 ## 验证方式 ## 面试叙事 ## 复盘检查清单 ## 后续风险或改进方向
一句话总结:用一句紧凑的话说明实现了什么,以及其技术或业务价值。
背景与目标:阐述原始问题、用户需求、所属业务或工程背景,以及明确的成功标准。
已完成工作:逐条列出可验证的具体交付成果,例如新增/修改的行为、变更的文件、调用的 API、UI 状态变化、部署配置更新、产出的文档等。
核心实现:说明主要技术方案设计、数据流向、关键方法/类/组件及其协作关系。
解决的关键难点:聚焦需工程判断的问题,例如需求模糊、集成失败、环境异常、边界情况、性能瓶颈、兼容性问题、权限限制、数据一致性挑战,或调试过程中的意外发现。
优化点与权衡取舍:说明为何选择当前方案、被否决的替代方案,以及在可维护性、性能、可靠性、可读性或用户体验等方面所做的改进。
关键代码索引:列出关键文件路径、函数/组件/类名称,并附简要说明;若行号可靠,可标注具体行号;代码片段应尽量简短,以引用加解释为主。
验证方式:记录实际执行的命令、运行的测试、人工检查步骤、截图、构建结果、部署验证结果,以及已知尚未验证的部分。
面试叙事:提供 2–4 条第一人称表述、可用于技术面试的要点,并在里程碑内容足够充实的前提下,补充可能的追问问题及简洁有力的回答。
复盘检查清单:以紧凑的条目形式罗列用户后续可快速扫读的关键内容:核心概念、常用命令、易错陷阱、典型模式、领域术语等。
后续风险或改进方向:指出尚存的技术风险、待偿还的技术债、需关注的监控指标,或下一步合理可行的工作项;不虚构问题,对不确定性需明确标注。
验证方式 中直接注明。最终生成的文档应能切实帮助用户回答以下问题:
相关专题
热门下载
相关下载
精品课程
共6课时 | 54.7万人学习
共89课时 | 134.1万人学习
共49课时 | 82.6万人学习
最新文章