Documentation Portals vs. KBs

Two "big" words in today's documentation are Documentation Portals and Knowledge Bases. For the first time in decades, it really does seem that we are seeing the end of PDF as a viable alternative for online applications (or any documentation that doesn't involve some element of hardware). With all these tools and formats, how do we decide what goes where? The simplistic answer is that we have to go, as always, according to the needs of our users.…

Comments Off on Documentation Portals vs. KBs

Moscow and Documentation

While researching for a presentation, the concept of "Moscow" was discovered. Its brilliance and its relevancy is as relevant today as it was when created in 1994 by Dai Clegg, of Oracle. Moscow represents a means of defining features for a product, or in our case,  documentation priorities.  Those who are familiar with JIRA will be familiar with the High, Medium, and Low ratings. There are others as well. But somehow, once you learn about MoSCoW, it's easy…

Comments Off on Moscow and Documentation

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

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