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

engineering-excellence

Skill0 starsChanged 3 months agoMITView on GitHub

Audits code for KISS, YAGNI, DRY, SOLID, and testability; maintains living engineering notes under .heyeddi/docs/engineering/. Use when refactoring, before merge, or when the user asks for simple scalable design, architecture notes, reuse catalog, or engineering ADRs: not for visual UX (use ux-flow-auditor) or CI gates (use pre-merge-gate).

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

5 rules. About 0 are common, 2 are distinctive, and 3 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈2

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 3

    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 11
  2. Distinctive:

    After a feature ships: capture how it works

    line 15
  3. Distinctive:

    Before adding abstractions: check reuse catalog

    line 16
  4. Very specific:

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

    line 36
  5. Very specific:

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

    line 37

≈ “Common” is an estimate: at least 1 in 5 of the 364,980 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.

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

When to use

  • 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 and doc init to Task shell. Main chat interprets findings and updates living docs.

Pipeline

init_engineering_docs   → .heyeddi/docs/engineering/{architecture,reuse-catalog,decisions}.md
implement / refactor
audit_engineering       → .heyeddi/docs/engineering-audit-<date>.md
append_decision         → ADR when trade-off is non-obvious

Instructions

  1. First time in project: python scripts/init_engineering_docs.py --project-root <root>
  2. While coding: read reuse-catalog.md before new components/composables/services
  3. After meaningful change: update architecture.md module map and add reuse rows
  4. Non-obvious trade-off: append_decision.py --title … --context … --decision …
  5. Before merge (non-trivial): audit_engineering.py --check (add --strict for warns)

Principles (how we enforce)

PrincipleSkill behavior
KISSWarn on oversized files; prefer flat modules
YAGNIFlag abstraction names without clear reuse
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

  • @project-engineering: scaffold first
  • @composable-patterns / @backend-type-bridger: after architecture notes exist
  • @pre-merge-gate: final CI; this skill is advisory + docs

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.