Release Notes

Thinking about release notes

Release notes, changelog whatever you want to call them, is a critical way to communicate with customers. I’ll attempt to define what release notes are, the content and who should...

Changelog

Thinking about release notes

Release notes, changelog whatever you want to call them, is a critical way to communicate with customers. I’ll attempt to define what release notes are, the content and who should...

release notes

Current Writing Setup

I’ve recently created a perfect writing setup that I can use for both work and personal projects.

visual studio code

Current Writing Setup

I’ve recently created a perfect writing setup that I can use for both work and personal projects.

vale

Current Writing Setup

I’ve recently created a perfect writing setup that I can use for both work and personal projects.

pandoc

Almost 0 dependency local site

I had to solve for a curious use case. Creating documentation that can be used locally, is easy for other to contribute to and has little to no dependencies. There...

lujnrjs

Almost 0 dependency local site

I had to solve for a curious use case. Creating documentation that can be used locally, is easy for other to contribute to and has little to no dependencies. There...

Recommended Reading -- Divio Documentation System

Update: I’ve learned this system was actually created by Daniele Procida. You can read a really great in depth explanation at Diátaxis.

documentation

Proving the Value of Documentation

Tell me if you’ve been in this position before. You have a manager who doesn’t really know what you do, you’re the last to know about product releases, people forget...

Why Your Documentation Sucks

I want to talk about a thread on Hacker News titled The tree-based approach to organizing documentation sucks (worldofbs.com). In the article the author laments the standard tree based way...

technical writing

Proving the Value of Documentation

Tell me if you’ve been in this position before. You have a manager who doesn’t really know what you do, you’re the last to know about product releases, people forget...

Why Your Documentation Sucks

I want to talk about a thread on Hacker News titled The tree-based approach to organizing documentation sucks (worldofbs.com). In the article the author laments the standard tree based way...

learning

Learn to Code for Technical Writers

Being able to understand and read code is becoming expected of Technical Writers. For this article, when I refer to technical writers, I refer to those who’s work will eventually...

code

Learn to Code for Technical Writers

Being able to understand and read code is becoming expected of Technical Writers. For this article, when I refer to technical writers, I refer to those who’s work will eventually...