Technical writing is indispensable for startups. It plays a critical role in enhancing product usability, facilitating both internal and external communication, supporting agile development, building brand credibility, ensuring compliance, and ultimately contributing to the startup's success. By prioritizing technical writing, startups can secure a competitive edge and effectively navigate the complexities of growth and change. … Continue reading Strategies for Startup Technical Writing
Category: General
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 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
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
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
User Guides vs Tutorials
Technical documentation provides some nifty tools to help the audience gain new capabilities. Two of these tools are user guides and tutorials. At first glance, they may seem similar. The following table compares and contrasts them for better understanding and implementation. AspectUser GuideTutorialPurposeComprehensive instructions on all features and functions of a product.Step-by-step guide to complete … Continue reading User Guides vs Tutorials
Technical Writer’s Guide to REST APIs
REST APIs are widely used in web and mobile app development for their simplicity and flexibility in enabling communication between different systems. Documenting REST APIs is an essential practice for developers and technical writers to ensure that users can understand and integrate with the API efficiently. For some reason, however, this tends to come across … Continue reading Technical Writer’s Guide to REST APIs
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
Empowering a New Era of Autonomy and Innovation through Decentralization
In recent years, the concept of decentralization has gained traction across various fields, from technology to governance. At its core, decentralization is about distributing power and control rather than concentrating it within a single authority. This shift reflects a fundamental change in how we view ownership, decision-making, and community engagement. Let's get into the details! … Continue reading Empowering a New Era of Autonomy and Innovation through Decentralization
Double Yew! 