Writing for Techies

Archive for the 'General Thoughts' category

Packing & Moving

February 5, 2009 11:34 am

Turns out my moving schedule has extended itself past all reasonable limits. We’re in the process of packing and moving right now (I expect to actually move in about a week), so while I’ll try to post some updates during that time, problems with Internet access and such will likely cause difficulty getting online. I’ll be picking up again for sure once we’re settled in our new location.

Moving in the next week

January 25, 2009 3:05 pm

I’ll be moving in the next week, so there will likely be some interruption in my posting schedule. I’ll try to get some posts ready to go, but no promises.

I’m really learning about spam!

January 16, 2009 10:20 am

Since I started this blog, I’ve been trapping spam and rejecting it before it gets posted. I’m amazed at how much there is targeting blogs like this one. There is no discrimination, no attempt to get it to any sort of right place. Further, there is no apparent concern that it doesn’t get posted, just that it gets submitted. It’s hard to believe someone pays for this stuff, but obviously they do.

I’ve got to ask myself WHY? Why would someone PAY to have someone do this?

The stuff they’re trying to post isn’t just ’spam’, it’s junk. There’s no relation to the topic, just get some links out there. The worst ones are the ones that are trying to social engineer by posting something that LOOKS OK superficially. They have embedded links to questionable locations that have nothing to do with the topic or the words in the post.

So why? It’s simple really. People are making money at it. In fact, people are making millions of dollars doing this.

Changed my Presentation

January 2, 2009 8:22 am

I’ve been experimenting with different screen layouts. I found that I like this one and especially because I can put my own pictures in the header.

Reflecting on Tools - continued

December 15, 2008 6:32 pm

SECOND - Mindmapping - Mindmapping continues to be a major tool in my arsenal when it comes to initial work on topics or problems. I worked with several tools in the course of this project and don’t see a way to get rid of any of them.

My Journal - Mindmapping in my journal is essential to me as i start making sense of something. I can get high level information together, find links between different pieces of information, and develop my understanding.


MindMapbyHand-Iono.jpg

As I read or study a piece of material, I mind map it in my journal. I normally use a two-page layout for major mind maps with lots of information and one-page for high level overviews. I also use my journal for mind dumps to get out what I know when I’m starting to read.


MindMapbyHand-RWP.jpg

Mind Mapping Software - I find that there is a definite advantage at some point of shifting to software to work with the information. The point in this project where it started to make sense was just before I started writing. As I was gathering information and sorting out my sense of the situation, I used my journal to mind map informally, but as I got near to needing to put the information into a meaningful linear format, I used mindmapping software to 1) dump everything I could remember about the specific piece I was working on. I did this for each lesson. 2) I reviewed my mind dump and determined where I had holes. I indicated this by putting questions into the mind map which I wanted to answer. 3) I found answers within my research material for the questions I had on the mind map. 4) I did additional research as necessary to answer the remaining questions. Finally 5) I organized the mind map into an outline to order my thoughts for linear presentation. In some cases I would have liked to use a non-linear presentation, but the format required linear presentation for the material. It would also have taken time I was not given to translate the course into a non-linear format.

One piece of software I used extensively in this process was the freeware FreeMind. For example, this is part of a dump I did on NVIS propagation in the final stages of writing a new lesson:


MindMap.gif

I find this is a very good way to get all the information out and organized so I can get ready for the actual writing.

Reflecting on Tools

December 14, 2008 6:17 pm

As I finish up a major project updating some online training material, it’s time to reflect on the tools I’ve used and what they brought to the effort.

FIRST - Scrivener - This was my first major project where I used Scrivener to support the project from beginning to end. I played with it and used it for portions of other things, but this time I started with it to start the project and finished with it as well. So on reflection, was it useful or not?

I have to say that Scrivener was of major use to me during the project. I setup my research in different folders, identified and drafted the lesson units, and brought everything together easily. It’s ability to open two document windows allowed me to see what I was writing at the same time as I had a piece of research available online.

During the writing, I reorganized several times, shifting research materials and building new categories as folders in which I placed other folders. My biggest problem was keeping my references straight. If I kept the full web page as I needed to, I had to download the page first to edit and get rid of extraneous stuff in the page. If I let Scrivener bring the page it, it brought the whole page including embedded ads and such, but it kept the reference to the page straight. Eventually, I developed the habit of recording reference information as part of every research document, but it took some time to sink into my head.

… More later

Scrivener & MarsEdit updates

November 22, 2008 6:57 pm

I mentioned in an earlier post that I was trying these applications to see how helpful they are. I have to admit, I’ve become dependent on them. I work on them daily and they’ve become my standard places to work on things.

ScrivIcon.jpg

Scrivener


Scrivener has become the place that I go to build the stuff I write. The more I learn about it, the better it’s become as a tool for me. I use it to manage writing projects by:

  • collecting my research on the topic
  • organizing my drafts as I work through them
  • roughing what’s being written
  • managing my references

I’ve modified my workflow now so that I usually work on something like this

FIRST - I start sketching out ideas in my Journal using mind maps, drawings, or any other way of feeling out the topic
SECOND - As soon as I’m ready to start looking ANYWHERE, online or off, I open a Scrivener project for the topic and start collecting information
THIRD - As I collect my material, I’ll start drafting parts of my piece, reorganizing as needed to find something that makes sense
FOURTH - When I have what I think of as a FINAL draft ready in Scrivener, I’ll export it to WORD and polish it. Most places I need to deliver things to want WORD format, so that becomes my final stop.

Scrivener is available from the Literature & Latte web site for $39.95.

MarsEditIcon128.jpg

MarsEdit


MarsEdit has become the way I manage my blogs. I find it very easy to use and more than capable enough to handle what I need to do. At least, I haven’t been limited by it except in handling comments. MarsEdit is only available at the MarsEdit web site for $29.95.

I’ve also experimented with Windows based editing tools for blogs inluding Blogdesk, BlogJet, and Windows Live. I know Microsoft’s entry gets a lot of good press, but I think I prefer Blogdesk at the moment.

Should YOU be writing corporate materials?

September 28, 2008 7:29 pm

A recent release on PRWeb titled “Help! I’m Stuck With Business Writing Tasks And I Can’t Spell Dieabotticle!” speaks about a booklet called “Leave It To The Prose” recently released with hints for people who need to write for their business.

I haven’t seen the booklet, but I’d bet that it overlaps with much of what I’m saying here. The author, Chris Amorosino whose web site is at http://www.amorosinowriting.com is quoted as saying “Words are a business’s clothes. Don’t go out to your prospects naked …”, a sentiment I can agree with.

The point here that strikes home more than any other isn’t about writing, but it’s about the reality of working in a business today. With the economy struggling and people being laid off left-and-right, we all need to be as flexible as we can be. If you’re asked to write something, can you do it? If you’ve got a technical background, can you write a user’s guide or a web page that will help make your company successful.

Can you ‘Make Your Ideas Clear’?

Just a few notes on the blog

September 16, 2008 3:39 pm

For anyone who runs across this blog, this is a new blog. I’m just starting it up, so while it’s getting it’s legs, I’m restricting posting to people who are willing to sign up and log in. This is primarily for me to get some time to get used to new software and to get some history into the bog. I intend to open it up for everyone to comment, but I will be posting some guidelines for what postings will be acceptable. For example:

  • I won’t edit comments except to cut out flames or obscenity.
  • I will block anyone who tries to use this blog for advertising something not related to the blogs topics
  • I won’t allow posts that link to sites that I don’t personally recommend. If anyone puts a link in a post, I’ll visit it first to confirm that I support it

Terry

Are you as frustrated as I am?

September 11, 2008 2:11 pm

Over the years, I’ve been frustrated by people who simply can’t communicate. They don’t write well, they don’t speak well, and they don’t get their ideas across effectively. More than anything, this affects people who are ‘technically inclined’. Several years ago, I put together a small presentation for clients taking several hours that dealt with writing for techies. I was amazed at how well received it was. I’ve modified it several times and even done the session with editors and writers for two magazines. But that’s just a drop in the ocean. I want to do more.

This blog is about writing, speaking, and more generally communicating. The target audience is people who are usually more interested in technology than writing. They’re often reluctant to speak in front of a group. When they write, the make mistakes in spelling and grammar. Their thoughts are often disorganized. If you’re one of these people, then this blog is for you.

Understand at the start that I’m not an English teacher. In fact, I disliked English classes in High School and at University. I HAVE written a lot of material including two books, one of which was very successful. I’ve also been a speaker at international conferences and in front of groups ranging from the front line to the board room. I’ve had some experience. I hope to pass it on to you.

I want to pass on the experience I’ve gained and thoughts I’ve had about what worked and what didn’t. This isn’t an English class or a class in any language, but I hope that the ideas I’ll talk about will benefit anyone in any language. I also hope to make this interactive, responding to questions from people who need help.