agentleFS
HeyEddi-comHeyEddi-com/heyeddi-skills/skills/engineering-excellence/SKILL.md

engineering-excellence

Skill0 starsChanged 3 months agoMITView on GitHub

ALWAYS-ON: audits plans and code for KISS, YAGNI, DRY, SOLID, and testability; maintains .heyeddi/docs/engineering/. Use on every chat that plans or changes code, before merge, refactor, ADRs, or reuse-catalog work. Not for visual UX (ux-flow-auditor) or full CI (pre-merge-gate includes this audit).

1 other project uses a version of this.

Adopted by

Most recently taken up by

The file

We split this skill into the rules it gives an agent

7 rules. About 0 are common, 3 are distinctive, and 4 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈3

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 4

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    All artifacts go under .heyeddi/docs/: never repo root.

    line 15
  2. Distinctive:

    After a feature ships: capture how it works

    line 20
  3. Distinctive:

    Before adding abstractions: check reuse catalog

    line 21
  4. Very specific:

    While coding: read reuse-catalog.md before new components/composables/services

    line 43
  5. Very specific:

    After meaningful change: update architecture.md module map and add reuse rows

    line 44
  6. Distinctive:

    When you have finished the user's request for this skill (not after every tool call or subagent phase), suggest what to run next:

    line 78
  7. Very specific:

    Add --route /path if you worked a specific route.

    line 86

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Engineering Excellence

Simple solutions that scale: documented so the next agent does not over-build or repeat work.

Always on for every chat that plans or changes code. See reference/engineering-always-on.md and hub docs/always-on-skills.md.

All artifacts go under .heyeddi/docs/: never repo root.

When to use

  • Every chat that proposes an implementation plan or edits code
  • After a feature ships: capture how it works
  • Before adding abstractions: check reuse catalog
  • Refactor / architecture review: KISS, YAGNI, SOLID
  • User asks: "don't over-engineer", "document the system", "engineering notes"

Subagents (default)

See reference/subagents.md. Delegate audit_engineering.py, check_engineering_plan.py, and doc init to Task shell. Main chat interprets findings and updates living docs.

Pipeline

check_engineering_plan  → plan gate (docs + optional plan smells)
init_engineering_docs   → .heyeddi/docs/engineering/{architecture,reuse-catalog,decisions}.md
implement / refactor
audit_engineering       → .heyeddi/docs/engineering-audit-<date>.md (--check = errors fail)
append_decision         → ADR when trade-off is non-obvious

Instructions

  1. Plan gate (every chat before coding): python scripts/check_engineering_plan.py --project-root <root> --check (add --plan-file when a written plan exists).
  2. First time in project: python scripts/init_engineering_docs.py --project-root <root>
  3. While coding: read reuse-catalog.md before new components/composables/services
  4. After meaningful change: update architecture.md module map and add reuse rows
  5. Non-obvious trade-off: append_decision.py --title … --context … --decision …
  6. Change gate (every chat after edits): audit_engineering.py --check (errors fail; warns advisory). Use --strict only when the user asks for warn-blocking.

Principles (how we enforce)

PrincipleSkill behavior
KISSWarn on oversized files; error when extreme; prefer flat modules
YAGNIFlag abstraction names without clear reuse; plan gate errors on new Factory/Manager without reuse cite
DRYMaintain reuse-catalog.md; chain @no-duplicate-ui for UI
SOLIDWarn on fat routers; views thin, services fat
TestableNote views missing smoke specs

.heyeddi/ outputs

PathPurpose
.heyeddi/docs/engineering/architecture.mdSystem map, data flow, boundaries
.heyeddi/docs/engineering/reuse-catalog.mdWhat exists: do not rebuild
.heyeddi/docs/engineering/decisions.mdEngineering ADRs (not design log)
.heyeddi/docs/engineering-audit-<date>.mdPoint-in-time audit report

Design decisions stay in .heyeddi/design.md Decision log: do not mix.

Chain

  • @heyeddi: always-on router before this skill when the task is ambiguous
  • @project-engineering: scaffold first
  • @composable-patterns / @backend-type-bridger: after architecture notes exist
  • @pre-merge-gate: final CI; includes audit_engineering --check

When the task is complete: suggest next skills

When you have finished the user's request for this skill (not after every tool call or subagent phase), suggest what to run next:

  1. Run:

    python .agents/skills/heyeddi/scripts/suggest_next_skill.py --current-skill engineering-excellence --project-root .

    Add --route /path if you worked a specific route.

  2. Include the script's ### Next step block in your final reply. The user copies the Prompt line into chat (e.g. @visual-auditor review and fix /settings).

Pass --mode audit when the change-gate audit just finished.

See @heyeddi → reference/next-skill-handoff.md.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.