Design

Designing software well is hard.

Neudesic has collected a number of practices which we find help in the design process. This covers not only technical design of software, but also architecture design and non-functional requirements gathering for new projects.

Goals

• Provide recommendations for how to design software for maintainability, ease of extension, adherence to best practices, and sustainability.
• Reference or define process or checklists to help ensure well-designed software.
• Collate and point to reference sources (guides, repos, articles) that can help shortcut the learning process.

Sections

• Diagram Types
• Design Patterns
• Design Reviews
• Non-Functional Requirements Guidance
• Sustainable Software Engineering

Recipes

• Design Recipes

Code Examples

• Folder Structure
  • Folder Structure For Python Repository
• Project Templates
  • Rust
    • Actix Web, Diesel ORM, Test Containers, Onion Architecture
  • Python
    • Flask, SQLAlchemy ORM, Test Containers, Onion Architecture

---

Last update: April 29, 2024