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: coding
Docs as Code vs Structured Authoring
In today's fast-paced technological landscape, the effective integration of documentation approaches is crucial for both software development and user support. Two prominent approaches to documentation are Structured Authoring and Docs as Code. Each of these offers distinct methodologies tailored to specific needs and workflows. Structured Authoring emphasizes the creation of content using predefined structures and … Continue reading Docs as Code vs Structured Authoring
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
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
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 – Encapsulation
This post marks the beginning of a series aimed at exploring essential programming best practices for technical writers, starting with the concept of encapsulation. Encapsulation involves hiding the internal workings of a system or component and exposing only necessary interfaces. For technical writers, this means being able to clearly document how users should interact with … Continue reading Programming Best Practices for Technical Writers – Encapsulation
Double Yew! 