Atlassian no longer lets users comment on its documentation – good or bad news?

Last week, Atlassian sent out this message on Twitter:

This was a surprise, as Atlassian has been a strong advocate for having user comments appended to user documentation. Sarah Maddox, when she was working at Atlassian, posted the reasons why the company encouraged comments on her personal blog:

Continue reading

Is it possible for Technical Authors to write content more quickly?

Approximately 50% of a Technical Author’s day is spent writing. However, when Technical Publications teams look for efficiencies, they tend to focus on the 50% of time spent on non-writing activities, such as researching, reviewing and planning. They assume the content itself cannot be written more quickly. To an extent, they are right, as the querty qwerty keyboard is not an optimal layout.

We’ve been going through a process of transcribing our early e-learning modules, in order to have scripts upon which we can base future course updates. As part of this project, we’ve been using a free application called Plover to help us write the content. With Plover, you have the potential to create content (in Word, RoboHelp, Flare, Oxygen XML etc) at up to 225 words per minute (wpm).

Plover is based on chorded typing. You press more than one key at a time to create words. Chorded typing isn’t new – for example, it was demonstrated in Douglas Engelbart’s famous “The mother of all demos“.

Below is a five minute lightning talk on Plover and some of the emerging hardware:

So far, in my case, I’ve been able to double my typing speed. Realistically, those of us participating in this project at Cherryleaf aim to get to 180 words per minute. The reason for this is that most people speak at 160-180 wpm. At that speed, you are able to transcribe subject matter experts in real time – which means there’s no need to record an interview and then type it up at a later date.

There is a learning curve to this method, but it is based on over 100 years of theory and practice. It is tremendous fun – a bit like learning to use a querty qwerty keyboard for the first time.

Not so cool tools for Technical Authors – speech recognition software

Our method for creating online courses involves making an audio recording of the presenter, transcribing it, editing the script and then recording the final, video presentation. We’ve tried using speech recognition software to create the transcribed script, and it has been a deeply frustrating experience.

While speech recognition is proving successful for searching and issuing commands (using Siri, Google Voice and Amazon Echo), we’re not sure it will replace the keyboard as the way we create written content.

Continue reading

Cool tools for Technical Authors – travel equipment

We’re sharing some of the tools we use at Cherryleaf. This time we’ll look at travel equipment.

The role of consulting technical communicator can involve travel to exotic places, such as San Diego, Cologne and Swindon. Your travelling experience can be affected by what equipment you have on your travels, so it make sense to take the right stuff with you. You don’t need to wander around places like Frankfurt Airport too many times, with a heavy bag across your shoulder, realise travelling for work can be both tiring and painful.

Continue reading

Cool tools for Technical Authors – video equipment

We’re sharing some of the tools we use at Cherryleaf. This time we’ll look at video recording.

screencast screenVideo is becoming an important medium in technical communication. In addition to screencast videos (walkthroughs of application screens), software like Camtasia and Captivate enable you to include video of people in your presentations. Doing this creates a more TV-like presentation and a more professional feel to your output.

Continue reading

Cool tools for Technical Authors – audio recording

We’re sharing some of the tools we use at Cherryleaf, and this time we’ll look at audio recording tools.

It can be very useful for a Technical Author to be able to record what someone is saying. If you are gathering information from a Subject Matter Expert, you can let them just speak naturally and quickly. This can reduce the demands on their time, and it often leads to a more relaxed conversation. There can be other instances where it’s not practical to use a notepad or computer to write or type notes.

Continue reading

Cool tools for Technical Authors – note taking

I thought I’d share some of the tools we use at Cherryleaf, starting with note taking. I’ve not covered audio recording tools, as we’ll probably look at those in another post.

Moleskine

Moleskine notebooksMoleskine notebooks are a great way of taking written notes. The 13cm x 21cm size provides a decent page size, whilst being small enough to fit into an external jacket pocket. The large rule notebook contains 240 pages, which means you’re likely to need only two or three per year.

The elastic closure stops the notebook from falling open, and the bookmark helps you find the next empty page. These can be handy also if you sometimes wake up with an idea in the middle of the night. They enable you to open and find a blank page in the dark, without having to turn on the light. Once the thought is recorded, your brain can settle down to returning to sleep.

Uniball eye pens

Uniball pensThe Uniball eye is a popular, everyday pen you can pick up from pretty much anywhere that sells pens. They are reasonably priced, so it doesn’t matter if you lose one, and they seem to last for ages. You can write with minimal pressure, as the ink flows smoothly. The pens are also comfortable in the hand.

CamScanner Pro

One tool we all use is a mobile phone app called CamScanner Pro. CamScanner enables you to scan a document using your smartphone’s or tablet’s camera. It means everyone has their own personal scanner wherever they go. The app converts the image into a PDF, and then enables you to upload the document to a cloud storage service (such as Dropbox) or email it to someone. The Pro, paid, version can also convert scanned images to editable documents.

Which tools do you use to take notes?

Let us know, using the comments box below.

Stenography for Technical Authors?

Steno keyboard

This tweet caught my eye:

It linked to an article The 100 Year Old Trick to Writing at 240 Words Per Minute:

About four years ago, stenographer Mirabai Knight came to the conclusion that stenography had been a walled garden for too long — controlled and marginalized by big companies. She set about creating her own affordable hardware and open source software designed to set stenography free to the masses…

Note that this keyboard does need to be able to recognize multiple simultaneous keystrokes, so gaming keyboards (starting at $50) are the norm.

This could really help us when we’re transcribing the scripts for our online training courses. We’re not aware of any Technical Authors who use stenography – is there anyone out there?