Getting Started with Vale | Using Vale in Visual Studio Code
Getting Started with Vale Working with Vale is the best automation tool for technical writers. Why? Vale is an open source style guide linter (more … Read More
Gitbook vs Docusaurus – Technical Documentation Tool Comparison
Gitbook vs Docusaurus. Are you debating on whether or not to use a Static Site Generator (SSG) for hosting your documentation? There are several SSGs … Read More
The Best Technical Writing Tools
Do you ever struggle as a Technical Writer, and wonder how things could get easier? Though Technical Writing isn’t a well known profession, outside of … Read More
Top Five Technical Writing Style Guides You Should Know in 2022
You cannot write good documentation without a clear plan. Does your documentation seem different depending on who writes it? Does it sound too wordy? Do … Read More
How to conduct a great user interview
Writing good documentation is hard. One issue that makes it so difficult is knowing what kind of documentation your team should write. A great way … Read More
Why Do Your Docs Suck? How to Improve Tech Docs
How to improve technical documentation? Why does technical documentation suck? How many times have you heard, “smart team, but the project has no documentation.” Or … Read More
How to Write a Getting Started Guide
Purpose of Getting Started Guide A Getting Started Guide may also be referred to as a Quick Start Guide; however, a Getting Started Guide typically … Read More
Who Owns the Documentation, and Why It Should Be the Robots
How to automate your documentation using GitHub actions Introduction If you’re a SaaS company, developer documentation is an essential part of your content strategy. 90% … Read More
Nerds Don’t Respond To Marketing; Try Technical Documentation Instead
Nerds Disdain for Marketing Technical documentation is effective marketing. Many tech startups, especially open-source ones, treat marketing as a dirty word. Many of these founders … Read More
Stop Writing Documentation That No One Reads – Know Your Audience
You’ve spent the whole quarter lovingly writing v1 of your company’s ‘getting started guide’. You press publish and then…🦗🦗🦗. Why isn’t anyone reading your documentation? … Read More