The ScreenSteps Blog for Onboarding, Training, and Enablement (59)

Categories
Follow Us

Employee/Customer Onboarding, Training and Enablement

Come to ScreenSteps blog to learn how to onboard, train and support your employees and customers.

Recovering From a Disasterous Git-rebase mistake

By: Greg DeVore
March 26th, 2009

Yesterday was adding the finishing touches to a marketing redesign of our screenstepslive.com site. This had been through many iterations but I felt that I finally had things the way I wanted them. ScreenSteps Live is entirely programmed in Ruby on Rails, both the web application and the marketing/sign-up area. We use Git for all of our version control.

Does Your Documentation Connect the Dots?

By: Greg DeVore
February 10th, 2009

The other day I was watching my 5-year old complete a connect-the-dots page. I was amazed at how such a simple concept could turn just about anyone into a semi-functional artist. All he had to do was draw one line at a time between two numbers. At the end he had completed a drawing that would have been far beyond his ability had the dots not been there. This is exactly how your documentation should be. Software is not art. It isn't golf. It isn't the violin. You shouldn't need to work years and years to master it. There is a task. It needs to be done. People are going to use your software to do it.

Software Documentation Tips | Documentation Managers

Plan to Not Plan

By: Greg DeVore
February 3rd, 2009

I don't ever plan my documentation. I used to. But not anymore. It's a waste of time. Maybe if I were on a documentation team and had 6 months to get the documentation ready then maybe I would plan. I could plan and then revise and then plan some more. But I am not on a documentation team. I run a business. I am the web programmer, accountant, custodian, sales person, system admin and business development director. I don't have time to plan my documentation. So what have I done? I have planned not to plan. I have created a system for documentation that requires no planning at all AND creates documentation that is much more useful to our customers. It really is quite simple. Just follow these simple steps:

Previous All posts