Tuesday, 20 December 2011 09:40

Dazzle ’em With Your Documentation Style!

Written by  Nada Spariosu and Patti Rueffer
Rate this item
(0 votes)

FEATUREDec20thBusiness analysts know it's always about the what and not the how... or is it? Capturing the what is obviously key, but if the what is all you've got in black and white text, it's highly doubtful that your audience will read it, let alone get it. Clearly it's not just about what you deliver but how you deliver it. Ask yourself what stands out about a really good message—you'll be surprised to discover that the delivery can sometimes stick with you just as much or more than the actual message. That's also true when writing requirements. It’s one thing to document the content but what's key is how to capture your audience.

If you take your documentation seriously and want to try a few simple things to grab your readers’ attention, you'll need to take your message and polish it, shine it and essentially dazzle 'em with your documentation style. Not convinced yet? Let's take a closer look at when to use these simple tips, who would benefit from them and why it's so important. We'll even teach you how.

Who is your audience?

So who cares about your document... and what do they care about?

Your audience can range from individuals who need a lot of detail to those who are only concerned with high-level information. Refer to BABOK Figure 1-3: Examples of Generic Stakeholders. For instance, your end users, subject matter experts, testers and programmers typically require things to be spelled out in detail. On the other hand, our project sponsors and executive audience may thrive solely on broader high-level project information.

PattiDec202

A Guide to the Business Analysis Body of Knowledge (BABOK Guide). Figure 1-3: Examples of Generic Stakeholders.

The idea here is to capture everyone's attention, and you can do that if you make your work shine. The trick is to make your document user-friendly by allowing readers to find information quickly and at a glance. A document that includes details and summations, and that is well organized and easy on the eyes, will definitely capture the attention of your entire audience when presented in a user-friendly format. Learn more on how to achieve this in the 'How do I do this?' section later in this article.

Where can you use these tips?

The places you can use these tips is unlimited. Use them in:

  • business requirements documents (BRD)
  • presentations
  • emails
  • any documentation that you do in your career.

We believe these tips are invaluable personally and professionally.

What can you use these tips for?

Think about the multiple audiences a business analyst needs to capture and satisfy. This role delivers much more than the BRD. From requirement elicitation notes to communication of options, while delivering documentation you should always think, "Have I got their attention?" and "How do I keep their attention?" Continually think about the message you want to convey and what your wow factor is for delivering that message.

When should you do this?

So when does it make sense to polish your documents? Does it make sense for every email you send and every document you write? The simple answer is “yes” but reality will teach you that you need to tailor your efforts and only do what makes sense.

Documentation that shines not only allows you to capture the attention of your audience but it also helps you to effectively communicate your work. Give your documentation the attention it deserves and do it right from the start.

On a project, be sure to continue using dazzling documentation right through BRD completion and when supporting the project team and change management process. In other words, write everything, all the time, as if it were being published.

Ultimately, you always want your documentation to have an impact, whether you are persuading the audience, conveying an understanding, selling an option or outlining business requirements.

Why should you take the time to make your documents shine?

There are so many reasons why but we've narrowed it down for you.

You want to make sure your documents grab the reader's attention and keep it. We've all had that experience of a project member (e.g., programmer or tester) asking you a question that is already covered in the business requirements document (BRD). If your BRD shines, you'll increase the odds of that person actually reading and using your BRD.

Your document also has a place in the future. Although it's integral to the current project, opportunity or challenge at hand, your documentation becomes a valuable point of reference in the future. Repeatable projects can benefit from your documents that require very little rigor each year.

Other benefits delivered by your shining documentation:

  • artifact for future project startups
  • training
  • living documentation

By using various documentation techniques, your documents become clear, concise and unambiguous. They are easier to maintain and make changes to. Any future audience can understand your document. If your reader gets it, your document is effective and you did your job well.

How do I do this?

And finally, what you've all been waiting for… how you get started. We hope that this section will give you some ideas regarding how to make your documents shine.

There are easy things you can implement right away.

  • Use white space so it’s easy on the reader's eyes and visually partitions your document.
  • Use lists or tables.

For example, if you are detailing out a new report, instead of using paragraphs or lists, consider using a table.

Report Heading

Description

Format

Field Rules / Calculation

 

 

 

 

 

 

 

 

 

 

 

 

  • When making changes to an existing screen, use a screen capture tool to visualize the changes.
     PattiDec201
  • Use colour—just don't go overboard with it. Using too much colour can be distracting.

There are lots of diagramming techniques you can use that are documented in the IIBA's BABOK. Diagrams are an excellent way of communicating your requirements. Consider using these techniques:

  • data flow diagram
  • data modelling
  • decision tree
  • process modelling
  • prototyping
  • sequence diagrams
  • state diagrams
  • SWOT matrix

Using them in the right way and at the right time can be very powerful. It’s like the old adage that "a picture is worth a thousand words."

To sum things up

We should all take the documenting of requirements seriously. It’s not just what you are putting in your requirements document but how you are delivering the message. It can make the difference between requirements, and requirements that are superior. So, jazz them up and dazzle 'em with your documentation style!

References
A Guide to the Business Analysis Body of Knowledge (BABOK Guide). Version 2.0.
International Institute of Business Analysis. 2009. 

Don't forget to leave your comments below.


Nada Spariosu and Patti Rueffer have 30+ combined years of experience as business analysts within IT departments in financial organizations. Both are IIBA members and have obtained their CBAP certification. Nada Spariosu is a member of the Waterloo-Wellington, Canada chapter of the IIBA.

Read 6877 times Last modified on Monday, 02 April 2012 16:07

Comments  

 
0 # Kupe 2011-12-20 07:43
@Nada and Patti - I see what you are saying. I do have an issue with this statement "In other words, write everything, all the time, as if it were being published." I think it is bad practice to feel you should do something all the time and the highest quality. Not everything needs to be written down and it does not always need to be publish worthy. More thought needs to go into deciding what has to be documented and why. Everything is not reusable. Business analysts need to keep in mind the value they are adding to project results with any documentation and task. Do you disagree with that?
Reply | Reply with quote | Quote
 
 
0 # Anita Da Mina 2011-12-20 07:48
Good article. I totally agree. The addition of diagrams like context diagrams and business process models assists the reader in understanding the scope of the project requirements.
Reply | Reply with quote | Quote
 
 
0 # colin 2011-12-20 10:54
This is an excellent article, which outlines something that all BAs should be aware of. As documentation is the key BA deliverable, I believe that we should make the effort to ensure that any documents that are formally issued look professional. This should not take much extra time to do and enhances the reputation of the document author and BAs in general. Also, given the large amount of money (usually) allocated to the analysis phase of a project, the extra amount of time spent on document presentation and layout is negligible. In addition to the points in the article I would add some even more basic suggestions, such as: -Proper use of paragraphs, -Co nsistent use of section headings, -Cons istent use of font type and size throughout the document. -Cons istent use of headers and footers (eg. page number in the same position in ever section), -Page breaks where necessary (eg. don’t start a new topic at the bottom of a page), -Plenty of white space. Before issuing the document use the ‘print preview’ function to check the layout and do a spell check. None of these suggestions should take any extra time if done from the start of the document, yet they result in a document that looks polished and professional – and one that the intended audience is far more likely to read.
Reply | Reply with quote | Quote
 
 
0 # Milton 2011-12-20 17:33
Agree with the article. We even took it further in that the IT team attended a 'report' writing course to look at multiple styles of writing business cases, requirements, monthly reports, business plans, e-mails etc. Biggest take away point - different industries have inherently different styles. Adapt your style to the industry, culture of the company. Eg Insurance, Banking LOVE spreadsheets, totals and tables whereas Media, Advertising prefer punchy headlines, graphics, powerpoints, ues of colour etc.
Reply | Reply with quote | Quote
 
 
0 # Eric van der Staaij 2011-12-20 17:34
Nice article, although I was expecting a little bit more tips on writing styles for appealing content, instead of style (at least the header got my attention :) I suggest any BA to take some time and get used to applying styles instead of independently formatting elements with color, bold, underline, size, spacing. Many times I have seen people getting frustrated with MS-Word's formatting quirks, but most of the times it's due to overlaying independent formatting on top of formatting on top of formatting etc, leading to hard to understand visual results. It really doesn't take much to learn styles: Simply do not touch formatting buttons again! The trick is to just mark your text and tell it what type of element it is (i.e. heading, emphasis, sub title). You are probably already used to using heading styles. You can format the style for the element itself, which is reflected throughout your whole document. Lear ning how to use styles properly will speed up your documentation efforts and make your documents look consistent. Ch eers, Eric
Reply | Reply with quote | Quote
 
 
0 # Simona 2011-12-20 17:43
Very good advice, thank you! I have one question, how can I use this approach when documenting business requirements using only excel? I have recently changed jobs and at the new company the BRD template is an excel. Thank you!
Reply | Reply with quote | Quote
 
 
0 # Gayle 2011-12-20 22:12
Simona, Excel 2007 has some great report formating features. Check out the styles section on the ribbon. Your report will look great!
Reply | Reply with quote | Quote
 
 
0 # Dawn 2011-12-20 23:41
Nicely said. Backing up the verbiage with diagrams, illustrations and mock-ups of the solution is probably the best chance you have of getting the point across clearly - which is the only reason to document in the first place. The point about targeting your style to the reader is important, also. As the saying goes, "begin with the end in mind!" We want our documents read, understood and actionable.
Reply | Reply with quote | Quote
 
 
0 # Ravi Pardesi 2011-12-21 03:29
Nice Article. I would also use a Glossary of Terms that provides: a) definition for all terms used in documentation that sets the right perception b) provide consistency for document author to call A as A throughout, not a, (a), [a], {a}
Reply | Reply with quote | Quote
 
 
0 # Tom 2011-12-22 18:24
Guys, I really appreciate your effort writing this article and all is true...but don't you think that this is just too obvious what you have written here? Statements that documentation should be clear, contain tables and screenshots and especially graphical models and diagrams are not tips for me, but a must knowledge for a BA that performs his/her job on a daily basis! Assuming that we are all BAs reading this article I'm a bit disappointed of its content.
Reply | Reply with quote | Quote
 
 
0 # Leslie 2011-12-23 06:28
'Backing up the verbiage with diagrams, illustrations and mock-ups of the solution is probably the best chance you have of getting the point across clearly' I just picked on 1 or many quotes that portray this message. This is great advice, but I would take it 1 step further to change it to read 'Backing up diagrams with verbiage that is consistently clear to read and understand is the best chance of getting the point across.' See what I did - made the diagram the focal point and use text in order to explain the diagram, where it needs clarification. The thought process goes like this; I am given a document to read. What is the first thing I see? The front cover. The front cover needs to tell me whether I want to spend valuable time opening up this document. I am not suggesting putting diagrams on the front cover, unless they really help to describe the content of the document, but whatever you do put there make sure it attracts the attention of the right people to want to open the document (just like a commercial book cover). The next thing I see is probably the inside front cover - 2 pages this time. If those 2 pages do not attract my attention I am going to be reluctant to read any further. Here's where you might want to put your first diagram and explanatory text that gives an overview of the contents and why I should read further. Once I get through the introduction and you have my attention, you may start adding boring stuff to the contents, but don't put all the boring stuff near the front in consecutive pages, else I may just decide that this is not worth reading afterall. You might want to put a high level table of contents on page 3, so the reader knows where to start reading from, without having to search for 'their' stuff. Do not put Glossary of Terms, Version Information or Terms and Conditions anywhere near the front of the document. Nobody reads these and if they go past 2 pages, you've just dampened any interest that might have inspired me thus far. Put them in an appendix (if necessary) and tell the reader (up front) where to find this stuff. Now that you have my attention and I know what appears to be of interest to me, the author needs to hold my attention. A screen or page full of words is going to score negative points. Pictures, especially if in colour will score plus points. Put the picture first and then use text to refer to what it is the picture is saying. When you have fully described the picture, enter another picture and describe what that is saying. Right, now you have my interest until you run out of pictures. A picture says a thousand words, but if you don't put those words after the picture I don't know which words they are.
Reply | Reply with quote | Quote
 
 
0 # Sweta 2011-12-27 18:39
A very good article. Most of it may seem obvious, but are usually bypassed in regular documentation. Most of use tend to use diagrams and mockups. The trick is to use the right ones and also the right number. Too many make it seem like a picture book - all pictures and little or no substance. Coli n's comments are very relevant and I have of recent realised their value. Consistent formatting and lot of white space make the document seem very readable. A Spelling and Grammar check is the most important. Of course, the author should have a decent vocabulary, else 'Executive Summary' would read as 'Executive Summery'.
Reply | Reply with quote | Quote
 
 
0 # Meg 2011-12-29 05:31
@Tom - as I just read this article I was thinking the exact same thing, but also how I've seen a consistent lack of it on formal documentation published by BA's of all experience levels. Even with using these same type of "tips" since I began as a BA, I still come up with ways to improve my documentation to appeal to new and different stakeholders. That's the fun part of the job!
Reply | Reply with quote | Quote
 
 
0 # Martin Schedlbauer 2012-01-03 07:20
Why not use more modern technologies to capture our stories and insights, such as wikis. Too many BAs are stuck with Word and Visio. Use collaborative cloud-based technologies and really build living "documents" that are more like repositories than static snapshots.
Reply | Reply with quote | Quote
 
 
0 # David Cook 2012-01-03 09:02
@Martin, like the concept...suspe ct it would be a major sell to PM's and stakholders!
Reply | Reply with quote | Quote
 
 
0 # TA 2012-02-11 11:10
Problem: a lot of professionals, or shall we say people employed in IT and also in various business management positions, still consider documentation "verbiage" or can't appreciate a well written documentation. The fact that they are not native speakers of English is not necessarily the cause of this attitude. Writing well in - or for - an environment like this will be a painful experience and a thankless job for the author.
Reply | Reply with quote | Quote
 

Add comment