Technical Writing

Read more about the article And the Adventure Continues – Gitbook
Technical Writing / Tools

And the Adventure Continues – Gitbook

Did I mention that I love working with startups and I love working with new tools? Well, let's see how Gitbook holds up. Back in November, I started working with a small client. Their tool of choice (literally) was readme.io. Despite limitations, I was able to deliver a very nice "mature" looking help file as requested. Now, some months later, they're back with a new interface and a new documentation tool. Gitbook. Gitbook Once again, I was handed…

Comments Off on And the Adventure Continues – Gitbook
May 23, 2021
Blogging / Technical Writing

Being Aligned

Alignment: it's critical to be aligned in so many ways. Aligned has many levels of complexity and its exact definition may change from company to company. But an overall definition of alignment might simply mean that everyone knows what they are doing, has access to the information they need to accomplish their tasks, and is synchronized with those to whom they must deliver or from whom they need information. Recently, I was reminded of the importance of being…

Comments Off on Being Aligned
February 7, 2021
Help Authoring / Products / Technical Writing / Tools

Readme.io Ouch

In November, I began an adventure with a new tool, readme.io. At least, new for me. I like to think all tools add something to your portfolio of skills. I enjoy learning new tools. Mostly, I like to find the unique benefit. So when I was hired by a small startup with only 14 people, I was eager to discuss what they wanted me to deliver and what tool I would use. The company was in stealth mode.…

Comments Off on Readme.io Ouch
November 25, 2020
Technical Writing

What Name Shall I Name?

It's really easy for users to know what something is called in the product they are using. They just have to read the documentation...right? The problem is...how did that name get in the documentation? Is it the right name? As technical writers, we know that sometimes we can ask the marketing department; sometimes we can ask the developers. But when you live in a place where the language of the product is considered the second (or third or fourth…

Comments Off on What Name Shall I Name?
February 20, 2017