Professionalism Series- 3: You, the company, and writing documents

September 5, 2006 6:42 am 0 comments

Share this Article

Author:

This is the one thing people in companies have the greatest aversion to.

I have been surprised even to have team leads and managers tell me that a certain minimum amount of metrics were ‘too much of an overhead to be effective’.

Anything is more effective than having no idea what anyone is doing in the company.

Here is the hard truth: Every professional’s life in every company is full of documenting activities, ideas and decisions.

I agree that documentation can seem like a time-consuming overhead, but it is only such if you consider it an overhead.

In fact, documentation is often a necessary part of working in a company – often more important than the actual work.

The most important reason for this is the idea of ‘future reference’. Someone should be able to ‘go back’ in the future to find out what you did today, why you did it, and why that made sense. That someone is most likely going to be you.

Everything we plan and decide needs to be written down so that we can get back to it later on. Everything we do should be written down as evidence of why we chose to make a certain decision.

Reasons to go back can be many — unless you can go back to understand exactly why you made a certain design decision, you will end up discussing the same thing over and over again and add unnecessary overheads in your design process. Reinventing past decisions is an overhead, not documentation.

Unless you can say “What was the decision we made which resulted in this win / loss?” you can never be accountable for both rewards or losses.

Most quality-standards, such as ISO or CMMI, base their recommendations primarily on what to document, how much of it to document, how to structure the document, and how to perform the process of documentation. Clearly, putting methodology in the way you can create written evidence of your activities / decisions has a profound way on the quality of the company operations.

Why should everyone need to document things?

The part that a lot of people have issues with is why they (be they graphic designers, marketing or creative staff, system admins, technicians, support staff, engineers etc) should have to document, when it should only be a manager’s job.

In truth, a manager’s job is not necessarily to document things, but perhaps managers understand the importance of doing so much more.

Everyone in the company should be able to describe their deicisons so that the rest of the team can know precisely what is happening, when it is happening. This helps the team, as a whole catch any risks or issues early and fix them early, rather than creating chaos when that decision fails later.

In addition, much of the documentation is specific to the person involved in the tasks — if your work results in a research publication or patent, no ‘technical writer’ will ever be able to help with that.

The best way of documenting

The easiest way of writing down evidence is to document-it-as-it-happens. Trying to first get the job done, and then starting on building documents will certainly take way too much time (time that business in the world today cannot afford to spend).

It is better to be documenting concurrently as you are doing things. Always have a notepad or word document or something open, and keep jotting down your thoughts as soon as you realize that piece of thought could be important to someone, somewhere.

If you do this, you will notice that it only takes a few minutes out of your tasks, but immediately gives you miles of benefit.

If your company provides IT tools, making full use of them also helps, because the tools will automatically create audit trails around your activiites.

The mind-set shift

As I said at the start, the basic shift in the mindset required is when you can accept that creating documentary evidence is an unavoidable consequence of working in a professional environment.

It is an inherent part of being a professional, because it helps the entire company run like a well-oiled engine.

So on the way towards greater professionalism, start getting more familiar with your typing speed.

Facebook comments:

Leave a Reply


*

Recent Posts

  • Events General Mobile Apps Container Run a continuation of politically motivated apps

    Container Run a continuation of politically motivated apps

    First we had Angry Imran which brought smiles and some short lived fun for us during the election campaign. Then came Gullu Butt following the incident of Model Town Lahore, which stayed on top of charts (Pakistan play store) for quite some while. Also Gullu Butt made an update with having the famous “Aam Khaiyga” quote form Aamir Liaqat in which a character resembling Aamir Liaqt throws mangoes and the Gullu Butt character tries to catch them. Gullu butt currently has more than 100,000 Installs

    And now during this extremely politically tense situation which had the whole nation on its toes on 14th August we have another app continuing the …

    Read more →
  • Announcements Featured Startup General Meritaleem.com aims to help student make better decision regarding their future.

    Meritaleem.com aims to help student make better decision regarding their future.

    MeriTaleem.com aims to solve an age old problem for our students, where to go next?

    If you have just completed your primary school which college to pick, if you have completed your college which university to pick. There has always been lack of information or rather consolidated information regarding these questions. The best source till now has always been relatives and friends (mostly of your parents). So some uncle did CA and made a good living you should talk to him and decide, or daughter of my sister completed her medical and is practicing follow that career.

    The fact that online presence of our existing universities are limited and not …

    Read more →
  • General Mobile Apps Eccentria Technologies launches an app which shoots to the top of the charts

    Eccentria Technologies launches an app which shoots to the top of the charts

    Whoa!! this was quick so Eccentia technologies launched an app a few days ago called “Ajj Kia Pakaen” or what to cook today and today it has reached the top of charts for Pakistani Stores on iTunes and google play store.

    “Ajj Kia Pakaen” is the most common question asked at every house hold in the morning. The ladies of the family have a hard time deciding what to cook for the day. The app has a fun interface and is simple to use, you fire it up, and it gives you an option of what to cook for the day, if you like the option you can check the …

    Read more →
  • Coffee Session General Marketing/Adv Rise of facebook marketing in Pakistan

    Rise of facebook marketing in Pakistan

     

    Until a few years back we used to have closed groups and forums, which gathered the like minded people and anyone targeting the online audience would tap into that forum and market his/her services. So PakGamers , PakPassion initially even PakWheels used to be driven by members talking about what they loved, people used to create marketing and sales opportunities from within those discussions (so you could get a good router cheap or a gaming PC etc).
    The advent of facebook changed all that, most of the forum goers moved to the new social media. It also made a very attractive market place for some one who does not …

    Read more →
  • General Getting back

    Getting back

    I  have been out of blogging for a long long long time, a lot of things happening on personal front (including a little startup I have ben doing my self). However during my absence I met a lot of people who had followed GreenWhite at its peak, read the articles regularly.

    I had hope there would be some one else who would come ahead and cover everything going on and around us in the local tech world. There are some guys doing a great job, but for some reason I still could not find one source where I can go and read about everything, so my routine usually is to …

    Read more →
  • General Mobile Apps Software & I.T. GeniTeam launches official app for Pakistan Idol

    GeniTeam launches official app for Pakistan Idol

    GeniITeam has successfully launched an official app for PakistanIdol. This is one of the first collaboration between a reality game show and a local app development company. I am sure a lot more would follow. Previously we have seen seenreport becoming the basis of mostly all channels citizen reporting system (Like Geo Dost). This is a healthy sign and with the advent of 3G round the corner it should become a business generator for our local firms.

    App allows you to follow the contestants that you like, promote them, comment on live feedback on an episode. It offers official content from the show since it is developed with partnership with …

    Read more →
  • General 10Pearls and National Geographic Release A Geography Challenge App

    10Pearls and National Geographic Release A Geography Challenge App

    10Pearls, one of the leading Pakistani IT companies, has recently added another feather to its cap. This time, in partnership with National Geographic, 10Pearls has released the new and improved GeoBee Challenge App – an interactive app to challenge and grow the geographic knowledge of the users.

    Each year thousands of schools in the United States participate in the National Geographic Bee using materials prepared by the National Geographic Society. The competition is designed to encourage geography in the classroom, ignite student interest in the world around them, and increase public awareness about geography. Schools with students in grades four through eight are eligible for this entertaining and challenging test …

    Read more →
  • General 10Pearls Spins Off Game Plan8

    10Pearls Spins Off Game Plan8

    It’s heartening to see that Pakistani IT companies have now started to diversify themselves into non traditional areas, and are competing with global players in areas such as gaming. We have received information that 10Pearls, one of the leading  mobile and enterprise web development services companies in Pakistan, has spun-off a separate entity focused solely on developing and publishing casual mobile games.  The new entity, Game Plan8, will focus on creating 2D and 3D games for the iOS, Google Android, Kindle, Facebook and other platforms. Details can be seen on the company’s official press release at http://www.prweb.com/releases/2013/12/prweb11428177.htm

     …

    Read more →
  • General Telecom CCP Gives Guidelines Against Telecom Companies’ Deceptive Marketing

    CCP Gives Guidelines Against Telecom Companies’ Deceptive Marketing

    If only were there two things when it comes to the law, firstly the fear of breaking it and by passing the legal authority, and secondly, implementation of the law given full dedication, there would have been less competency and dishonesty in business and society. However, keeping good faith, the Competition Commission of Pakistan (CCP) has put forward “Deceptive Marketing Guidelines” which will maintain the Section 10 of the Competition Act, 2010. In order to enforce this part of the law and stop anti-competitive conduct on part of the telecom companies in advertising, the guidelines have been shared with Pakistan Telecommunication Authority (PTA) and other concerned telecommunication sector members, in …

    Read more →