Docs as Code has long been associated with developer-centric workflows, but the same principles can empower documentation teams. By integrating Docs as Code into internal processes, writers can collaborate on code samples, improve accuracy, and ensure consistency across documentation. This article outlines a strategy for enabling doc teams to maintain and share their code samples … Continue reading A Docs as Code Strategy for your Doc Team
Tag: programming
Are Decentralized Oracles Essentially APIs?
In the blockchain world, decentralized oracles are essential technologies bridging the gap between blockchain and off-chain systems. For those familiar with traditional software development, decentralized oracles may seem similar to APIs (Application Programming Interfaces), as they both serve the function of fetching and delivering external data. They share similarities but go far beyond a standard … Continue reading Are Decentralized Oracles Essentially APIs?
Is Solidity an Object-Oriented Programming Language?
Solidity is the leading smart contract programming language for developing decentralized applications (dApps) on Ethereum and other Ethereum Virtual Machine (EVM) compatible blockchains. Since many developers come from object-oriented programming (OOP) backgrounds (for example, JavaScript, C++, or Python), a common question arises: Is Solidity truly an OOP language? The answer isn't straightforward. While solidity incorporates … Continue reading Is Solidity an Object-Oriented Programming Language?
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
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!
WebSockets – Paving the Way for Real-Time Interactions in the Future of Digital Experiences
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
Postman and Swagger, a Complimentary Rest API Pairing
Postman and Swagger are two powerful REST API tools that serve distinct yet complementary roles in API documentation and testing. Postman excels at facilitating hands-on API testing, enabling technical writers to send requests, observe responses, and generate practical examples that enhance user understanding. In contrast, Swagger focuses on creating detailed API specifications using the OpenAPI … Continue reading Postman and Swagger, a Complimentary Rest API Pairing
The Magic of the Command Line
I've kind of geeked out on the command line. While it's mostly used in programming, system administration, and development tasks to interact with the computer's operating system, a coworker at ServiceNow several year ago showed me it can be used for much more. He used the command line for Git version control, bypassing GUI-based software … Continue reading The Magic of the Command Line
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