Simulating Interfaces and Abstract Classes in JavaScript for Flexible, Polymorphic Code

In object-oriented programming (OOP), polymorphism is key to creating flexible, scalable code by allowing us to work with objects through a common interface. While JavaScript lacks native support for interfaces and abstract classes, we can simulate these structures with patterns that enforce flexibility and structure in our code. In this post, we’ll explore how to … Continue reading Simulating Interfaces and Abstract Classes in JavaScript for Flexible, Polymorphic Code

Simplest Way to Learn REST APIs Ever!

REST API explanations often make them seem more complicated than necessary. They're actually pretty simple. While they can handle highly complex tasks, introducing them is not so bad. In this post, my goal is to provide the easiest and most straightforward explanation of REST APIs ever! Here's what you'll accomplish: Learn the foundation of what … Continue reading Simplest Way to Learn REST APIs Ever!

Node.js vs JavaScript: Documentation

JavaScript is a fascinating language primarily used for web development. However, with Node.js, it extends its capabilities to server-side applications. Here’s a closer look at the key differences between regular JavaScript and Node.js: AspectNode.jsJavaScriptTypeRuntime environmentProgramming languageExecution EnvironmentRuns JavaScript outside of a browser (server-side)Used to write logic and functionality in web apps (client-side or server-side)RoleRuns on … Continue reading Node.js vs JavaScript: Documentation

JavaScript vs TypeScript

JavaScript has long been the go-to language for web development. It's known for its flexibility and ease of use. TypeScript, however, has gained popularity for adding static typing and better tooling, making it ideal for larger, more complex projects. This comparison highlights the key differences between the two. FeatureJavaScriptTypeScriptNature of LanguageDynamic, interpreted scripting languageSuperset of … Continue reading JavaScript vs TypeScript

Python vs JavaScript

I've been asked several times by technical writers transitioning to software development which programming language they should focus on. The answer depends on the specific area of development they wish to pursue. While JavaScript was once the unequivocal choice for web development, the rise of AI and its applications has shifted the recommendation towards Python … Continue reading Python vs JavaScript

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

Programming Best Practices for Technical Writers – Modularity

Welcome to the sixth installment of my series on essential programming best practices for technical writers. In the previous post, I covered the concept of polymorphism. In this post, we’ll shift our focus to the principle of modularity. Modularity is a design strategy that involves dividing a system into smaller, self-contained units or modules, each … Continue reading Programming Best Practices for Technical Writers – Modularity

Programming Best Practices for Technical Writers – Polymorphism

Welcome to the fifth part of my series on essential programming best practices for technical writers. In the last post, I discussed the concept of reusability. On this post I’ll focus on the principle of polymorphism. Polymorphism allows objects from different classes to be treated as instances of a common superclass, enabling them to respond … Continue reading Programming Best Practices for Technical Writers – Polymorphism

Programming Best Practices for Technical Writers – Reusability

Welcome to the fourth installment of my series on essential programming best practices for technical writers. Previously, I explored the concept of abstraction. In this post, I'll delve into the principle of reusability. Reusability is about designing components, code, or modules so they can be utilized across various parts of a program or different projects … Continue reading Programming Best Practices for Technical Writers – Reusability