WebSockets are a fascinating communication protocol that enables full-duplex communication channels over a single TCP connection. They are particularly beneficial for real-time applications, where low latency is crucial. My first encounter with WebSockets was while documenting the infrastructure of the metaverse through the brilliant, Yinch Yeap. In this context, an AppBus managed the dynamic pickup … Continue reading WebSockets – Paving the Way for Real-Time Interactions in the Future of Digital Experiences
Tag: software-development
The Pros and Cons of Docs as Code
Docs as Code has become prominent in software development, and for good reason. This approach treats documentation like code, advocating for writing, versioning, and maintaining documentation using the same tools and processes that developers use for software. This creates a much more seamless experience for documentation development. It streamlines workflows, encourages collaboration, and ensures that … Continue reading The Pros and Cons of Docs as Code
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 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 – 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
Five things you probably didn’t know you could do with ServiceNow Workspace
ServiceNow workspaces automate various types of workflows with a single pane UI. This single pane UI is designed to for minimal user effort so that users can efficiently resolve workflows. Workspaces perform the same function as classic lists and forms, but with functionality that is more intuitive. They incorporate familiar UI elements and maximize design … Continue reading Five things you probably didn’t know you could do with ServiceNow Workspace
Double Yew! 