: Re: Is there a standard for describing a form in a programming specification? I'm a web programmer at a small web firm. When we have a larger programming project, I write a specification document

There isn't a "standard way" to explain technical concepts to those who wouldn't understand, at least to my knowledge. I do, however, have a few techniques that you might be able to try when you have to write up a technical report in a simple way.

Break up your report into clearly divided sections. This allows for the reader to more clearly understand what they're looking at.
Define everything in easily understood words. Personally, I dislike looking at footnotes; it makes the document look more difficult or complex that it actually is. But the decision on where to define words is up to you.
Generalize. If you can give a small description of how something works without going into great detail, then give it as an overview.
If you can, use analogies and/or diagrams. Your tables probably help a lot, but make sure that they're big enough to easily read and see. Many clients likely don't want to have to think too hard about what a table is showing.
Get help. I often pretend I'm explaining things to my mom and that helps me use smaller vocabulary and generalize technological functions.

Unfortunately, this is something that might always plague tech developers. I do have one last suggestion, although it might not be the most ideal.

Keep your client on a partial "need-to-know" basis. Give them all of the information, but for the technical sections, leave it as complex and lengthy as it needs to be to share the information. Give them a general overview of collection methods/etc, but if they can trust you to develop a product that will achieve the intended objectives and meet the given requirements, then your job will be much easier. Offer to meet with them and go into more depth if they'd like/if you're able to, but if they won't understand it then they don't need to.

Load Full (0)

: Where to draw the line between fantasy and reality in a story? I realize this question may sound broad or vague, so allow me to explain. I never knew much about combat or dealing with injuries

@Berumen699

Load Full 8 Comments

: How to write a scene where something devastating suddenly happens? I've always struggled with writing scenes like these. For example, imagine a situation where two characters, Steve and Alice,

@Berumen699

Load Full 3 Comments

: How to write mail where the topic inside mail is not our concern Today I received a mail from our support team which is beyond our concern and we can't look into the matter. I need to mail

@Berumen699

Load Full 1 Comments

: Why are audio books more expensive than a movie ticket? Think of all the millions of dollars actors are paid, and all the thousands of people who scroll by in the credits. Surely the cost

: Re: Is there a standard for describing a form in a programming specification? I'm a web programmer at a small web firm. When we have a larger programming project, I write a specification document

More posts by @Berumen699

: Where to draw the line between fantasy and reality in a story? I realize this question may sound broad or vague, so allow me to explain. I never knew much about combat or dealing with injuries

: How to write a scene where something devastating suddenly happens? I've always struggled with writing scenes like these. For example, imagine a situation where two characters, Steve and Alice,

: How to write mail where the topic inside mail is not our concern Today I received a mail from our support team which is beyond our concern and we can't look into the matter. I need to mail

: Why are audio books more expensive than a movie ticket? Think of all the millions of dollars actors are paid, and all the thousands of people who scroll by in the credits. Surely the cost

Login to post a comment!

0 Comments

Back to top