Lesson Learned

作者 softaworks3027f20f3181无许可证2.5K 个星标收录于 2026年10月8日更新于 2026年10月8日仓库7个月前更新

Analyze recent code changes via git history and extract software engineering lessons. Use when the user asks 'what is the lesson here?', 'what can I learn from this?', 'engineering takeaway', 'what did I just learn?', 'reflect on this code', or wants to extract principles from recent work.

AI 生成的概览

通过 git 历史分析近期代码改动,提炼有依据的软件工程经验教训并给出反思性总结。

功能
先读取原则参考文件,再根据 git 历史确定分析范围(功能分支、最近 N 次提交、某个提交或工作区改动),并收集相关 diff 与提交信息。它找出改动中的主导模式,对应到某条软件工程原则,并按固定模板输出一条主要经验教训以及最多两条补充说明。该技能仅包含指令,产出的是书面反思,而非代码或文件。
适用场景
当用户询问能从近期代码中学到什么、想要工程层面的收获,或希望反思刚完成的改动时使用。适合审查分支、提交区间或未提交的改动,从真实代码中提炼原则。
运行要求
需要访问 git 仓库,并能执行 git log、git diff、git show 等 git 命令。需读取随附的两个参考文件 references/se-principles.md 和 references/anti-patterns.md。无需脚本、软件包、凭据或网络访问。

Lesson Learned

Extract specific, grounded software engineering lessons from actual code changes. Not a lecture -- a mirror. Show the user what their code already demonstrates.

Before You Begin

Load the principles reference first.

  1. Read references/se-principles.md to have the principle catalog available
  2. Optionally read references/anti-patterns.md if you suspect the changes include areas for improvement
  3. Determine the scope of analysis (see Phase 1)

Do not proceed until you've loaded at least se-principles.md.

Phase 1: Determine Scope

Ask the user or infer from context what to analyze.

ScopeGit CommandsWhen to Use
Feature branchgit log main..HEAD --oneline + git diff main...HEADUser is on a non-main branch (default)
Last N commitsgit log --oneline -N + git diff HEAD~N..HEADUser specifies a range, or on main (default N=5)
Specific commitgit show <sha>User references a specific commit
Working changesgit diff + git diff --cachedUser says "what about these changes?" before committing

Default behavior:

  • If on a feature branch: analyze branch commits vs main
  • If on main: analyze the last 5 commits
  • If the user provides a different scope, use that

Phase 2: Gather Changes

  1. Run git log with the determined scope to get the commit list and messages
  2. Run git diff for the full diff of the scope
  3. If the diff is large (>500 lines), use git diff --stat first, then selectively read the top 3-5 most-changed files
  4. Read commit messages carefully -- they contain intent that raw diffs miss
  5. Only read changed files. Do not read the entire repo.

Phase 3: Analyze

Identify the dominant pattern -- the single most instructive thing about these changes.

Look for:

  • Structural decisions -- How was the code organized? Why those boundaries?
  • Trade-offs made -- What was gained vs. sacrificed? (readability vs. performance, DRY vs. clarity, speed vs. correctness)
  • Problems solved -- What was the before/after? What made the "after" better?
  • Missed opportunities -- Where could the code improve? (present gently as "next time, consider...")

Map findings to specific principles from references/se-principles.md. Be specific -- quote actual code, reference actual file names and line changes.

Phase 4: Present the Lesson

Use this template:

markdown
## Lesson: [Principle Name]
**What happened in the code:**[2-3 sentences describing the specific change, referencing files and commits]
**The principle at work:**[1-2 sentences explaining the SE principle]
**Why it matters:**[1-2 sentences on the practical consequence -- what would go wrong without this, or what goes right because of it]
**Takeaway for next time:**[One concrete, actionable sentence the user can apply to future work]

If there is a second lesson worth noting (maximum 2 additional):

markdown
---
### Also worth noting: [Principle Name]
**In the code:** [1 sentence]**The principle:** [1 sentence]**Takeaway:** [1 sentence]

What NOT to Do

AvoidWhyInstead
Listing every principle that vaguely appliesOverwhelming and genericPick the 1-2 most relevant
Analyzing files that were not changedScope creepStick to the diff
Ignoring commit messagesThey contain intent that diffs missRead them as primary context
Abstract advice disconnected from the codeNot actionableAlways reference specific files/lines
Negative-only feedbackDemoralizingLead with what works, then suggest improvements
More than 3 lessonsDilutes the insightOne well-grounded lesson beats seven vague ones

Conversation Style

  • Reflective, not prescriptive. Use the user's own code as primary evidence.
  • Never say "you should have..." -- instead use "the approach here shows..." or "next time you face this, consider..."
  • If the code is good, say so. Not every lesson is about what went wrong. Recognizing good patterns reinforces them.
  • If the changes are trivial (a single config tweak, a typo fix), say so honestly rather than forcing a lesson. "These changes are straightforward -- no deep lesson here, just good housekeeping."
  • Be specific. Generic advice is worthless. Every claim must point to a concrete code change.

来源与署名

来源:softaworks/agent-toolkit位于skills/lesson-learned提交3027f20

许可证: 无许可证

内容归原作者所有。SourceWeft 从公开仓库中收录这些内容。

举报或申请下架