Programming Best Practices for Technical Writers

This series is dedicated to exploring the fundamentals of programming best practices for technical writers. Understanding these practices is crucial for grasping how software is constructed and reflecting these methodologies in effective documentation. Adhering to established patterns in programming also makes documentation more predictable and structured.

While there are two primary programming paradigms—functional programming (FP) and object-oriented programming (OOP)—FP is predominantly used in fields like data science and financial modeling. OOP, on the other hand, is the most widely adopted paradigm in software development. This series focuses on the best practices of OOP.

OOP best practices can be categorized into six key practices that include: Encapsulation, Inheritance, Abstraction, Reusability, Polymorphism, and Modularity.

Let’s start with Encapsulation.