skills.rest
huaxel
huaxelCOMMUNITY
Explore all skills by this author →
GitHub

software-design-principles

Analyzes code against YAGNI, DRY, KISS, SOLID, GRASP, and GoF design principles.

Updated Dec 11, 2024
Search Tags:#architecture#yagni#design-principles#solid#code-review#gof#grasp
One-click install
npx skills add https://github.com/huaxel/dotfiles --skill software-design-principles-huaxel
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: software-design-principles
Source: https://github.com/huaxel/dotfiles/tree/main/skills/software-design-principles
Command: npx skills add https://github.com/huaxel/dotfiles --skill software-design-principles-huaxel

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Code reviews often rely on informal heuristics, leading to inconsistent architectural decisions. This skill provides a structured checklist anchored in established design principles to guide reviews and improvements.

Core Features & Use Cases

  • Evaluate adherence to YAGNI, DRY, KISS, SOLID, GRASP, and GoF patterns during code reviews.
  • Identify design violations and propose concrete refactors and architectural improvements.
  • Use in architecture reviews, refactoring sessions, and design decision checkpoints.

Quick Start

Analyze a codebase with a design-principles-focused review and receive actionable recommendations.

Frequently Asked Questions about software-design-principles

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I check my code for SOLID, DRY, and KISS violations during a code review?▼

To check code for SOLID, DRY, and KISS violations during a code review, analyze the codebase against established design principles to identify structural issues and output actionable findings with improvement guidance.

What is the best way to evaluate architectural decisions against GRASP and GoF patterns?▼

Evaluating architectural decisions against GRASP and GoF patterns involves applying a structured checklist during architecture reviews to identify design violations and guide improvements across software projects.

Can I use a structured checklist to identify YAGNI violations in a refactoring session?▼

Yes, you can use a structured checklist anchored in the YAGNI principle during refactoring sessions to identify unnecessary code, propose concrete refactors, and guide architectural decisions.

How do I get actionable refactoring recommendations based on software design principles?▼

To get actionable refactoring recommendations based on software design principles, analyze your source code against YAGNI, SOLID, and GRASP categories to detect violations and output improvement guidance.

Does this design principles evaluation work for software projects of varying scale?▼

Yes, this design principles evaluation is explicitly applicable across software projects of varying scale, providing structured architectural assessments and code review checklists regardless of project size.

Why does informal heuristic code review lead to inconsistent architectural decisions?▼

Informal heuristic code review leads to inconsistent architectural decisions because it lacks a structured baseline, whereas applying established design principles provides consistent checkpoints to guide improvements.

Related Skills

Explore More Software Engineering Skills→
janekbaraniewskijanekbaraniewski
160

review-design

Review design documents against the codebase to report discrepancies.

Community
Intermediate
hnaht277hnaht277

analyze-auction-web

Analyze Auction Web Node.js/Express code for SOLID, KISS, DRY, and YAGNI violations and generate report.md.

Community
Intermediate
indoor47indoor47
9

analyze-code

Analyze codebases for structural issues and generate prioritized markdown reports.

Community
Advanced
Abrahan-EagleAbrahan-Eagle
1

clean-architecture

Enforce Clean Architecture boundaries and dependency rules during design and refactoring.

Community
Advanced