software-engineering

Notes on programming + best practices, design patterns, architectural patterns, and project management

• For actual implementations, see: ltskinner/cicd
• Includes:
  • 🏛️ Standard File Structure
  • 🐍 Python examples
    • setup.py
    • module.py examples
    • subpackage examples
      • relative imports
      • package __init__.py example
      • subpackage __init__.py example
      • subpackage usage
    • testing examples
      • executing tests
    • packaging example
  • ⚙️ Config file examples
    • .coveragerc
    • .gitignore
    • MANIFEST.in
    • buildspec.yml
    • logging.conf
    • requirements.txt
    • tox.ini

Quick Reference

Best Practices
Programming	Naming Conventions	Diagramming
Agile
Agile Rules	Sprint Planning	Sprint Review
Quality Assurance
QA Checklists - USE THESE

Step 1 - What

Requirements

"Requirements are like water. They're easier to build on when they're frozen"

• Code Complete Requirements
• The Pragmatic Programmer Requirements

Software Estimating

Step 2 - How

Architecture

Architecture is the design of constraints that apply system wide

"When you look at the architecture, you should be pleased by how natural and easayy the solution seems."

• Software Architecture in Practice
• Code Complete Architecture

Design

Design is the process of compartmentalizing the system into packages/subsystems, classes, and routines while keeping complexity to an absolute minimum

"Once you understand that all other technical goals in software are secondary to managing complexity, many design considerations become straightforward"

• Code Complete Design
• Design Patterns

Step 3 - Implement

Programming

• Code Complete Programming
• The Pragmatic Programmer

Quality Assurance

"If builders built buildings the way programmers wrote programs, then the first woodpecker that came along would destroy civilization"

• Code Complete Quality Assurance
• Python Unit Test Example

-> Peer Reviews

-> Testing

Software Metrics

• Agile Metrics

Step 4 - Project Teardown + Debrief

Maintenance

• Code Complete Maintenance

Administrative Project Teardown + Debrief