All we want is to satisfy our clients. We all want a friendly working relationship. But How we can do so?
My article today is concentrate in this point.
The most important thing is to have me as a service provider and my clients the clear vision with no ambiguity. Every thing must be written with clear words.
Writing is hard work, but we have no options. So we can do that by develop and assist technical writers with software documentation such as design documents, version description documents and user manuals.
When you take on a new project, before you even open Visual Studio, you need to have clear and agreed-upon design goals. And these goals should be established in a specification document. If the client hasn’t written one, you should write it, and submit it to them for review before you even open your IDE. And if you encounter a client who says, “We don’t have time for design documents”, candidly, you should walk away from the project because you have trouble ahead.
Without this document, you’ll end up in a loop of acrimonious equivocation, clients disputing what they told you or what you told them, angrily sending cut-and-pastes of previous communications, interpreting and arguing until the time comes when the client demands that you make changes to bring the application into conformance with “what they actually asked for,” and expects you to make those changes without pay.
With this software design document, you’ll have an answer to any such quibble: when disagreements arise, you can refer to the specification which the client agreed to and signed-off on, pointing out that you have fulfilled it to the letter. Instead of angry arguments, you’ll make amendments and clarifications to the document. If anything, the client will apologize for letting the imprecision slip through in the first place. It should be a description of the desired application, criteria for completion, and milestones.
Version description documents (VDD):
It is the primary configuration control document used to track and control versions of software to be released to the operational environment. It is a summary of the features and contents for the software build.
A user guide or user’s guide, also commonly known as a manual, is a technical communication document intended to give assistance to people using a particular system.