Understanding Cross-Origin Resource Sharing in Web Development

If you've ever built a web application that needs to communicate with a server on a different domain, you've likely encountered Cross-Origin Resource Sharing (CORS). CORS is a browser security feature that controls how a web page can access resources from another origin (domain, protocol, or port). While its purpose is to protect users, CORS … Continue reading Understanding Cross-Origin Resource Sharing in Web Development →

Understanding Many-to-Many Relationships in Object-Oriented Programming

In Object-Oriented Programming (OOP), many-to-many relationships are a powerful way to model complex interactions between objects. These relationships occur when multiple instances of one class are related to multiple instances of another class. Whether you're building a social network, an e-commerce platform, or a learning management system, understanding how to manage these relationships is crucial … Continue reading Understanding Many-to-Many Relationships in Object-Oriented Programming →

Cutting-Edge Trends and Techniques in Technical Documentation

In today's rapidly evolving digital landscape, the approach to technical documentation is transforming to meet the needs of diverse users and platforms. As technology advances, innovative methods such as interactive documentation, microlearning, and API-driven content creation are reshaping how information is conveyed and consumed. These developments allow for more engaging and efficient ways to present … Continue reading Cutting-Edge Trends and Techniques in Technical Documentation →

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 Methods

Finally, let's talk about methods. In your documentation hierarchy, a specific class contains its methods, with each method listed as a sibling to the other methods under that class. This structured organization helps illustrate the relationship between the class and its methods, making it easier for users to understand how to interact with the functionality … Continue reading Documenting Methods →

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 →

Full Stack of Development for Technical Writers

In this post, I want to lay out some basic programming concepts about full-stack development for technical writers. Technical writers may have programming degrees and formal developer experience, but often they don't and learn on the job through the tasks of their roles. This post will hopefully bridge some of the understanding of what's going … Continue reading Full Stack of Development for Technical Writers →