Discussion Locked

Putting it in Writing: Can It Break a Career Without It?

0 helpful
18 replies
Closed to new repliesThis discussion is closed. It stays readable, but it takes no new replies.

Ok...if I haven't learned anything else over the years, it's
"put it in writing." This stems from projects I've been
involved in when information was exchanged verbally, and
later the clients come back and says, "you never said that,"
or, "we never discussed those arrangements," or, "that's not
the quote you gave me." It's an awful position to be in
because, for one, there's no documentation to back it up.
This applies to working on someone's computer as well.
Without the disclosure of set policies that make it clear how
things works, the client thinks one way while I think
another. And it all goes back to the cliche' that the
"customer is always right" even if arrangements were made
verbally. If it's not written down, what else can you do?

In an opinion, I think without having policies well
documented and available to the client, and conversations
noted, it could cause more harm than good and as a tech
repair person, end up losing money than earned.

It's terribly important to "put it writing" because it not only
identifies the policies of operation, but with well kept
notes, it confirms any agreements and arrangements that
were made at the time of the service call.

I truly believe that to protect the business and avoid costly
lawsuits, and other ugly situations everything, and I do
mean everything, should be in writing all the way down to
the last period at the end of a sentence. It's simply good
bookkeeping, business and common sense.

I don't want to sound off my rocker here, it's just a matter
of keeping from getting burned and the client from feeling
burned. Any other thoughts on this?

18 replies

by dc_guy

You have to be careful not to overdo it. Many people don't believe that written records are important. These are usually people who are poor writers and/or poor readers, and a lot of them manage to do well in the business world. Even though they're probably wrong, when someone they do business with asks them to sign a lengthy contract or takes copious notes at a meeting, they think he's trying to take advantage of them.

Remember that no matter how carefully you prepare, you cannot avoid every potential problem, because many of them result from conditions that could not be foreseen.

So don't make a bad impression by being too formal.

by jaqui

of discussions, to be used to create the written guideleines for a project.
use a video camera. ( digital or not. )
give the client a copy of the recording, so that they can verify any details they have questions over with thier own copy.

end of tape is one person summarising the points for the agreement.

even if an individual has problems with the reading, the video record shows you are not out to get them,[ they can see and listen to it ] you don't have to write copious amounts in the meeting, and have a complete record of what the client wants, and what your understanding of thier wants is.

tell them, standard practice, for ensuring that the team has thier words exactly for working on the project.
( which isn't even a lie, as the team will more than likely review the video to clarify for themselves point of contention in the development cycle )

by stress junkie

I'm at a point where I want to create a certain level of documentation to provide to my clients for the reasons stated in this post as well as other reasons. Some documentation stating your standards and practices seems appropriate. It seems, though, that putting everything that you can think of in writing is going to confuse and scare your clients. You would end up creating lists of potential problems resembling the labels on over the counter drugs, which nobody reads and which few people would be able to evaluate if they did read them.

One event in my history that comes to mind happened quite a while back. I was going to upgrade a VMS system overnight. Just before the department manager left for the day she asked me what was the worst thing that could happen if things went badly. I told her that in the worst case the computer might never work again. That wasn't exactly true, but she wasn't the least bit technical and I couldn't explain that my "belt and suspenders" approach to system administration couldn't cover all of the potential problems that could arise. Now that I'm older I wouldn't make such a glib remark but it still illustrates that I believe nontechnical people often cannot evaluate the risks of common procedures and probably don't need to know every possible risk in everything that we do.

I am beginning to return to an opinion that I've held throughout my career. That opinion is that if we tell our clients that we use standards and practices that are common in the computer support industry to minimise risks then they will probably be content. Naturally we have to do what we say we will do and follow such procedures as they apply to whatever we are doing. In that case I think that the risk of litigation from a dissatisfied customer is minimal and the risk of that litigation being decided against us is even more remote.

Speaking of litigation, I wonder how many cases are actually brought against computer support people. We talk about it a lot but I am not familiar with any real cases. I was once asked by a consulting house if anyone had ever brought legal processes to bear against me from anything that had happened in work. I laughed. Later I thought that maybe she or her husband had faced legal problems from supporting some unhappy client. I don't know. But I have never heard of any actual cases against computer support firms, consultants, or whomever.

I wouldn't lose any sleep over it.

by comp1systems

I like what you've said, and it makes very good sense. Here
I am wrecking my brain over it and thinking, "perhaps, this
and this and this should be in writing," whereas I'm putting
way too much thought into it. The opinion you mentioned
about using standards and practices, can I use that? I'd like
to reflect back on that from time to time. I'm very early in
my career in this whole scenario, so I'm still learning as I go
along, and what I learn, I use that to know not to make that
same mistake again.

by checker_chgo

Putting requirements and even small changes in writing helps the PM and the sponsor understand the initial scope and changes to it. For example, if the sponsor insists on 17 small changes over the course of a multi-month project and each change takes one day, you'll find that you are one month behind in the schedule.

It might also help if you use the right words when communicating, such as "racking" your brain rather than wrecking it. At least I hope your situation isn't so desperate that your brain is actually being wrecked.
Further, when you say "verbally", please understand that "verbal" means "to use words". It does not distinguish between spoken or written words. If you intended to say that the requirement was given to you via oral (or spoken) communication, please say so.

My strong recommendation is to document every request and review the list as frequently as is logical in your situation with the requestor(s).

Good luck.

by gralfus

We built a house and the contractor didn't want to list his costs and such, and that if we insisted, we could find another builder. His work was so nice that we went ahead with it. The work was good, but not great. Water system was contaminated. No sump pump, so that had to be retrofitted. Bathroom wasn't to code, so when we sold it we had to compensate the buyer.

I learned from that to always get it in writing ahead of time.

by jamesrl

I will tell you that I think its in everyone's interest to document a project well. Documenting an assumption or a risk forces you to think about about it more, and getting a clearly documented plan that everyone agrees to helps avoid many misunderstandings.

I have experienced staff who save things like instant messages, save emails forever etc. I dislike the CYA thing. They often use it as a bludgen on their co-workers when we all know that things change, and our perspective changes as time goes by and we get more information. I suppose its not the saving itself, but the way the information is used that can be irritating.

James

by craig herberg

When working as a consultant with clients, you absolutely need to be clear up front about what you can and can't do, and what it will cost, either by the hour or by the job. For jobs large enough to require a contract, you should have a lawyer review for you, lest you end up paying to work.

As an employee, on the other hand, you should only document the really big projects. Those who find the need to constantly engage in CYA should look for alternative employment.

Good luck.

Craig Herberg

by dalmatian

I've read a number of the other posts but I have to say from experience that it is the only way to do business. It's a pain in the posterior, especially when you are just begining the practice, you have to get your clients used to it and you have to come up with the documents.

As a number of the other posts mentioned, it clarifies the relationship and what is expected. Even ignoring the potential for litigation, it avoids hard feelings down the road.

I once worked as a developer for a company where I spent as much time writing requirements, then specs then test plans as I did writing and debugging code. I thought it was excessive and a waste of time at first, then as I became a more senior analyst and dealt directly with the clients, I realized how valuable it was to have it all in writing. It really did save some relationships (not to mention my posterior) more than a few times.

I think the most difficult thing is how it is presented. I've encountered situations where the document is exceedingly restrictive and used as club on the other party. You really need to include some diplomacy to make it work as well as a handshake used to.

by arun.kumar

You must know what to document. Have a tool to document, which will index, link and store the documents.
Indexing and Linking implies Categories that the tool provides, under whose headings the documentation can be done.
Last but not the least, document what is required only.

by srinivas malay

By documenting the things will not only protects the business and avoid costly lawsuits, helps one in refering the same for his work.

Documentation acts as a means for communication, documenation helps in preveting defects.

It could be said as "?Know to Document and Document to Know?

by driedee

Most projects/changes I have been through, were badly documented to start with. I can only suggest the following to avoid getting burned:
- scope correctly and add full impact analysis (not only the 'risks' but also any 'obvious' dependencies etc... you might think it is low risk, but others might think differently). This triggers other team members as they read through the project definition document (PDD).
- add an issue log and a change log to the PDD. These list all issues you have + analysis + decision forward. Keep these logs updated at all times. BTW, this takes less effort than you think so just do it.
- think in products, not activities. Any activity must result in some sort of product(deliverable). Make sure product descriptions are clear and that everyone can understand then. (also read the walkthrough topic here: http://ct.techrepublic.com.com/clicks?c=155923-29363829&brand=techrepublic&ds=5)
- go through everything with your customer and have him signoff or agree on email with the versioned documents.

In general, unless you are a technical writer, you shouldn't write documentation ...
did I get your attention? read on ...

Check the purpose of documentation. If it is to enhance the user experience, you'll need a technical writer.
If you need it to enhance support services, don't bother writing books. Use concept mapping techniques BEFORE the project is defined as scoping/impact vizualization. These maps vizualize the whole effort, incl. dependencies. You can enhance them DURING the project, adding changes and deviations while you go. Effort is really minimal but you END UP with a realtime documented system, in contrast to the usual ill-scoped or incomplete documentation.
Go to http://cmaps.ihmc.us and check the setup of the pages. These are concept maps turned into html. Really usefull to document 90% of the systems.
I agree however that not all knowledge can be documented clearly using concept mapping and that other methods should be used, but I am documenting the full ebusiness code- and content management chain of one of the world's largest consumer electronics companies as we go ... adding new stuff daily and building projects/changes on top of the current concept maps (immediately shows impact).

by the_comp-aid_company

The writer at Comp1Systems@ certainly makes a strong case for documenting work associated with projects, and I couldn't agree more.

But please permit me to make a sligh divergence, and emphasize the importance of documenting code.

Now, most of you good folks are probably coding in C#, .NET, or Java. But I'm refering to FORTRAN, which --- believe it or not --- is still an oft used language.

With that in mind, let me ask the following. What if you have a FORTRAN module to which you've identified an error? You spend quite a bit of time analyzing it (perhaps days), in order to find the source of the errors. But your notes ("documentation") that you made were on scrap paper, or on knapkins, or on the back of old envelopes --- all of which soon got misplaced and lost once the maintenance is completed. So, when you come back to that same module a year or so later, you've got to start all over.

Why not refactor that FORTRAN module first, using our methodology of "Functional Blocks". (Go to the DOWNLOAD page of our web site at http://www.TheComp-AidCompany.com and download our 18 page technical report, "Overview of The Methodology of Functional Blocks" for a description.)

By refactoring this FORTRAN module right up front, you've accomplished two things: (1) you've found the source of the error, and (2) you've documented the module. Now, if that module ever comes up for maintenance again, or perhaps for enhancement, you're on board so much faster.

Respectfully,

Ronald C. Wackwitz
The COMP-AID Company
New Braunfels, TX 78132

by mmarris

I come from a military environment and "document everything" are words that make or break you. However, I've noticed in the civilian sector, many bosses would rather do away with the notes since they tend to "slow things down and wouldn't get read anyway." I accept their valid points and offer contradictory arguments. If they still disagree I take my own time to write it all down. You never know when the day will come that your notes are important...I'd rather be praised for my foresight than criticised for not doing something I know should have done.

by fmbanker

In my last organisation, I had a boss who would constantly ask me to show her in writing if that was what I or she had said the last time we discussed things. It became absolutely necessary to even write down how many phone calls I had made in a day (and to be extreme...how many glasses of water I had in a day). It is obvious why I left the company....

My current employer is the exact opposite of the lady! In the beginning I used to save every single mail that he sent me or every single chat session we had, but I ultimately realised that he knew what he had spoken or if he didn't remember it, he trusted me enough to believe me whenever I contradicted his version of things.

But my first experience was so bad (especially since it was my first job) that I have been badly burned and still do everything possible to safeguard myself.

Having said that...I just recently tore away a whole writing pad of notes that I had made about the discussions I had with my current employer (since he is in office only 10 days a month)...after saving them all on Notepad!

Its a case of Once Bitten Twice Shy! Sometimes, it becomes necessary to play it by the ear, but most of the time go by your instincts.

FMB!

by kirk webber

I totally agree with comp1systems, and I believe this applies to more than just the client/service provider relationship. All too many times in government, I've been to meetings where no official notes were captured and published, and entirely too often, people's memories of what was agreed differ considerably (particularly as time moves on). If two people have a meeting and minutes/action items are not captured and reviewed during that meeting, when those two people get up and walk away from the table, there's at least 3 opinions as to what was agreed on.

by kevaburg

What today's workplace is about is about covering your own head.

In my case, I have a form that says I am authorised to carry out the work.

Another says the work was carried out successfully.

Another says the last backup made is good to restore.

And so on and so forth.

It is not tricky at all. The client signs to say you can do it. And then the client signs to say they are happy with the work.

When all is said and done, all we can do is what the client said we can do.

This discussion is closed to new replies.