Documenting Classes

Classes serve as blueprints that define the structure (attributes) and behaviors (methods) of objects, which are instances of those classes. When documenting classes, you are essentially detailing the blueprint for creating, utilizing, and deploying the class effectively. This blueprint can come together on a unique page that captures the following: High-level Overview - At the … Continue reading Documenting Classes →

Documenting OOP Libraries

In this post, I explore how to document an OOP library. By following established documentation patterns, technical writers can create predictable, structured content that enables developers to leverage your software library efficiently and effectively. OOP documentation follows an imperative programming paradigm. This means that it focuses on how a program operates through a sequence of … Continue reading Documenting OOP Libraries →

Navigating AI Development: A Technical Writer’s Guide to Programming Paradigms

In a previous post, I laid out best practices for technical writers focusing on object-oriented programming (OOP). I also mentioned another important programming paradigm: functional programming (FP). While OOP is primarily utilized for software development, functional programming finds significant application in data science and financial modeling, particularly within AI. I’ll focus on AI development in … Continue reading Navigating AI Development: A Technical Writer’s Guide to Programming Paradigms →

Programming Best Practices for Technical Writers – Inheritance

This is the second post in a series dedicated to exploring the fundamentals of programming best practices for technical writers. The first post detailed encapsulation. This one delves deeper into inheritance. Simply put, inheritance enables a new class (subclass) to inherit the methods and properties of an existing class (superclass). This creates a hierarchical structure of … Continue reading Programming Best Practices for Technical Writers – Inheritance →