Skip to content

Single-page, at-a-glance revision notes for core Software Engineering - SDLC, requirements, Agile, testing, Git workflows, quality, and DevOps basics.

License

Notifications You must be signed in to change notification settings

a2rp/software-engineering-core-notes

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Software Engineering Core Notes

A single-page, at-a-glance revision project for core Software Engineering concepts.

This project is designed as a fast reference and structured summary sheet covering essential software engineering topics without unnecessary depth.
It focuses on clarity, software lifecycle thinking, quality practices, teamwork workflows, production readiness, and interview-ready fundamentals.



Purpose

  • Quick revision before interviews
  • Rapid recall of software engineering fundamentals
  • Clear mental model of how software is built, shipped, and maintained
  • Practical, production-focused reminders
  • Strong foundation in SDLC, requirements, design basics, testing, version control, and DevOps without overload

Coverage

  • What is Software Engineering

  • Programming vs Software Engineering

  • SDLC (Software Development Life Cycle) overview

  • SDLC Models

    • Waterfall
    • V Model
    • Iterative model
    • Incremental model
    • Spiral model
    • Agile model
    • DevOps model
  • Requirements Engineering

    • Functional requirements
    • Non-functional requirements
    • Requirement gathering techniques
    • SRS (Software Requirement Specification)
    • Use cases and user stories
    • Acceptance criteria
  • Design Basics

    • HLD vs LLD (High Level Design vs Low Level Design)
    • Architectural styles overview
      • Monolith
      • Microservices
      • Client-server
      • Layered architecture
      • Event-driven architecture
    • Coupling vs Cohesion
    • Tradeoffs and constraints
  • UML Basics (Unified Modeling Language)

    • Use case diagram
    • Class diagram
    • Sequence diagram
    • Activity diagram
    • State diagram
  • Estimation and Planning

    • Effort estimation basics
    • Story points
    • Velocity
    • Planning poker
    • Risk basics
  • Project Management Basics

    • Scope
    • Timeline
    • Stakeholders
    • RACI basics
    • Critical path overview
  • Version Control

    • Git basics
    • Branching strategies
    • Merge vs Rebase
    • Pull requests
    • Code reviews
  • Software Principles

    • SOLID principles
    • DRY (Don't Repeat Yourself)
    • KISS (Keep It Simple)
    • YAGNI (You Aren't Gonna Need It)
    • Separation of concerns
  • Testing Fundamentals

    • Unit testing
    • Integration testing
    • System testing
    • Acceptance testing
    • Manual vs Automation testing
    • TDD (Test Driven Development)
    • CI (Continuous Integration) basics
  • Code Quality and Maintenance

    • Clean code basics
    • Refactoring basics
    • Code smells overview
    • Technical debt
    • Maintenance types
  • DevOps Basics

    • CI/CD (Continuous Integration and Continuous Delivery)
    • Build pipeline basics
    • Release management overview
    • Containers basics
    • Monitoring basics
  • Documentation

    • README structure
    • API documentation basics
    • Change logs
    • Release notes
  • Security Basics

    • Authentication vs Authorization
    • OWASP basics overview
    • Secure coding habits
    • Secrets and configuration basics
  • Must-know interview questions and answers

Tech Stack

  • React
  • Vite
  • styled-components

Project Type

Single page only
Section-based navigation
Searchable and expandable content
No blog-style content, only structured notes

Each topic is modular and collapsible for fast scanning.

Run Locally

npm install
npm run dev

Goal

Complete core Software Engineering knowledge in one scrollable page.

  • No fluff.
  • No repetition.
  • Just production-level clarity.

Releases

No releases published

Packages

 
 
 

Contributors