Monday, January 19, 2009

Research, Analyze, Plan, Execute

I have been technical writing for over 10 years now and I have developed a methodology for creating documentation. This method isn't exclusive to just tech docs... it can be applied to almost anything we write in day to day life from a term paper to an email to your Peruvian pen pal. The method consists of four easy and intuitive steps. First you research, you analyze, then you plan what you're going to write before you execute.

Let's go into more detail on the four steps:

Research - I always tell people they cannot write in a vacuum. You need to understand your topic before you can write about. This step can be as simple as having a bit of information that you want to share in a letter, but more than likely you're going to have to put more effort into it. You are probably going to have to dig for the information you need. This means reading books, researching topics on the Internet, or getting to know your topic with hands on learning. -- When it comes to technical documentation the latter of those is going to be key. Until you have broken the product, you won't fully understand it.

Analyze - Now that you have gathered information on your topic you need to sit down and think about what you're going to do with it. Ask yourself a few questions: What did you learn? What will my audience want to know? How will they use the information? What do they need to do with the product? And so on...

Plan - Once you have figured out how the information will be used you can start planning out your document. Set up an outline based on the answers to the question in the Analyze phase. Organize your notes and information by copying and pasting (or transcribing) it into the proper sections.

Execute - Now that you have a framework to work within and your blurbs of information in the right spots, it's time to start developing the content. I recommend sitting down and just writing, which is sometimes called sprinting. Get the words on the page and don't worry too much about the grammatical structure or style. Get the ideas and knowledge in your head into your document before you lose it. There will be plenty of time for clean up later.

Once the content is there, the true writing portion is done. From there you can go through the process of revising, testing, and editing. This portion should not be done in a vacuum either. Get others involved. More eyes is never a bad thing. -- But for all intent and purpose, the true writing portion of the process has been completed.

Next time you need to do any writing keep these four steps in mind. Research, Analyze, Plan, and Execute. My R.A.P.E. method has worked well for me and I hope the rest of you find it useful as well.