Common Sense Diagrams

It is a misconception that diagrams in technical or requirement documents need to be purely factual and completely devoid of any emotion. It is essential that they tell a whole narrative, including (s-u-b-t-l-y) a bit of emotion to be completely successful.

I have seen diagrams used as a thinking apparatus. Draw something out so you can think it through, then make it all into words. The existing diagram is then used, with a few minor embelishments, to accompany the step.

This is not best practice.

By all means, use the diagram to think, but realise it is just a step. Throw the diagram away once you are finished with it.

Once you have a narrative in your head of what you want the chapter or section to say, you have to start again.

Look at your section - what are you trying to say? What do you want your audience to feel after reading it? Happy about the wonderous, shiny new software you are building for them? Or to be slightly apprehensive about the challenges that ahead in THAT integrations project? think it through.

Once you have a narrative, you are ready to start.

Start roughly, on a piece of paper. this is absolutely essential. do not start with a mouse.

doodle, and assemble a series of high level diagrams on paper. Asses it critically. Can you create more emotion? can you create more subliminal messaging? (I can feel another blog on this subject)

Then, you can start playing with your software.

This is, after all, common sense. We are visual beings, and certain things have an inexplicable effect on us that is well beyond our understanding. Why should diagrams be devoid of emotion? sure they should contain facts, but dont all good stories?

Remember, you can draw what you cant always write.