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
Programming Best Practices for Technical Writers – Abstraction
This is the third post in a series focused on the core principles of programming best practices for technical writers. The previous post covered inheritance and touched on abstract classes. In this one, we’ll dive deeper into the concept of abstraction. Abstraction involves hiding the complex implementation details of a system and presenting only the … Continue reading Programming Best Practices for Technical Writers – Abstraction
Programming Best Practices for Technical Writers – Inheritance
This is the second post in a series dedicated to exploring the fundamentals of programming best practices for technical writers. The first post detailed encapsulation. This one delves deeper into inheritance. Simply put, inheritance enables a new class (subclass) to inherit the methods and properties of an existing class (superclass). This creates a hierarchical structure of … Continue reading Programming Best Practices for Technical Writers – Inheritance
Solidity vs Vyper
Solidity and Vyper are both programming languages used for writing smart contracts on the Ethereum blockchain, but they have notable differences. Vyper is a newer, simplified language designed for ease of understanding, though it comes with fewer features. Inspired by Python, Vyper’s syntax is straightforward and readable, making it easier to write, read, and audit … Continue reading Solidity vs Vyper
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
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
Why You Should Use Cross-Program Invocation in your Solana Program
Cross-program invocation (CPI) addresses the limitations of confined application containers. Traditionally, applications were developed and packaged to include all necessary functionality, isolating them from others. This approach often led to extended development cycles, minimal code reuse, and vulnerabilities impacting entire applications. However, CPI enables Solana developers to transcend these constraints by building modular applications that … Continue reading Why You Should Use Cross-Program Invocation in your Solana Program
Commas Are Hard, but You’ve Got to Know Them
In an undergraduate English class I took, a teacher offered A's to anyone that used commas correctly in their papers. No one did it. This kicked off my journey to discover what made commas so difficult, and to learn how they're supposed to be used. Prior to college, I'd learned commas were placed with natural … Continue reading Commas Are Hard, but You’ve Got to Know Them
The future of technical communication in XR
We've entered an exciting time of extended reality (XR) and artificial intelligence (AI). In this Wild West both disciplines are in, it seems a pertinent time to reexamine the application of technical communications. I use technical communications instead of technical documentation or technical writing to broaden the scope to the many audiences, deliverables, and objectives … Continue reading The future of technical communication in XR
Double Yew! 