best-practices

Apply universal software engineering best practices like SOLID and DRY.

20|5|Updated Nov 2, 2025
One-click install
npx skills add https://github.com/GhostTypes/ff-5mp-hass --skill best-practices-ghosttypes
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: best-practices
Source: https://github.com/GhostTypes/ff-5mp-hass/tree/main/.claude/skills/best-practices
Command: npx skills add https://github.com/GhostTypes/ff-5mp-hass --skill best-practices-ghosttypes

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill addresses the challenge of writing clean, maintainable, and production-ready code by providing a comprehensive set of universal software engineering best practices. It helps developers avoid common pitfalls and build more robust systems.

Core Features & Use Cases

  • Fundamental Principles: Covers SOLID, DRY, KISS, YAGNI for robust design.
  • Architectural Patterns: Explains SoC, SSOT, LoD, CQS, DbC for scalable systems.
  • Operational Reliability: Details ETC, PoLP, CoC, Idempotency for production readiness.
  • Use Case: When refactoring a legacy system, use this Skill to ensure new code adheres to SOLID principles and avoids introducing technical debt.

Quick Start

Apply the KISS principle to simplify the current code module.

Frequently Asked Questions about best-practices

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

FAQPage Schema
What are the fundamental software engineering best practices for writing maintainable code?

Fundamental software engineering best practices for maintainable code include SOLID, DRY, KISS, and YAGNI principles. These design rules help developers avoid common pitfalls, reduce technical debt, and build robust, production-ready systems across any programming language.

How do I apply SOLID principles when refactoring a legacy system?

To apply SOLID principles during legacy system refactoring, use universal software engineering guidelines to ensure new code adheres to robust design patterns. This process prevents introducing additional technical debt and systematically improves architectural scalability and operational reliability.

What architectural patterns should I use for scalable system design?

For scalable system design, utilize architectural patterns such as Separation of Concerns (SoC), Single Source of Truth (SSOT), Law of Demeter (LoD), Command-Query Separation (CQS), and Design by Contract (DbC). These patterns ensure maintainable and structurally sound software engineering.

Does this approach to code quality work with any programming language?

Yes, this approach to code quality provides universal software engineering best practices applicable to any programming language or project. It covers language-agnostic design principles and operational reliability concepts necessary for ensuring production-ready quality across diverse tech stacks.

How can I ensure operational reliability and production readiness in my code?

To ensure operational reliability and production readiness, apply concepts like ETC, Principle of Least Privilege (PoLP), Convention over Configuration (CoC), and Idempotency. These operational best practices fortify system architecture and maintain code quality during execution.

When should I use the KISS principle over other design principles?

Use the KISS (Keep It Simple, Stupid) principle to simplify current code modules when unnecessary complexity threatens maintainability. It complements other software engineering practices like DRY and YAGNI by preventing over-engineering and ensuring production-ready code quality.