Amphoteric
Chemical
- Jul 25, 2007
- 23
At work I get passed around to different bosses and even departments, and one point of contention is the "calculation record" - also called a design brief or design calculation. Datasheets and technical drawings have a really defined structure, but calc. records do not. It seems that everyone has their own opinions on how to do it right! How much information and explanation put down, how much to reference, and so forth.
Put down too little, and you're confusing. Put down too much, and you're wasting everyone's time.
Please discuss: What is your personal "style" or "philosophy" when it comes to writing design briefs?
I wrote some questions for consideration (you don't have to answer them, they're just thought-stimulator's):
1) Who is the target audience? Do you write as if you'll be hit by a train tomorrow, and new-hire-Tim has to pick up your calculation? Or do you write the bare minimum to save time for you, and the person checking your work?
2) How do you show the development of your work? Do you write equations symbolically, define and reference the terms, and show all the gory detail? Or do you write a quick blurb on what you're doing and program the equations into Excel?
3) If someone tells you a number, do you reference the person by name? Some people say that's offensive: that you should "Company ABC said..." instead of "Joe said..."
4) If something is a "rule of thumb" or a number "based on my experience" do you reference it?
5) If you are using third-party software (e.g. simulators, CFD tools, etc.) how do you do the brief? How do you keep track of the what/why of your inputs? How do you make sure your results are valid?
6) How is checking done at your office, and to what level of detail? Is it done properly or does it fall by the wayside?
7) How do you like to check work, your own or someone else's? Do you go over everything with a fine toothed comb, or do you eyeball the numbers, or do the calc a second way and see if the results match?
I realize that the answers all depend on the complexity/novelity/stage of the design cycle you're in.
Thanks in advance.
Put down too little, and you're confusing. Put down too much, and you're wasting everyone's time.
Please discuss: What is your personal "style" or "philosophy" when it comes to writing design briefs?
I wrote some questions for consideration (you don't have to answer them, they're just thought-stimulator's):
1) Who is the target audience? Do you write as if you'll be hit by a train tomorrow, and new-hire-Tim has to pick up your calculation? Or do you write the bare minimum to save time for you, and the person checking your work?
2) How do you show the development of your work? Do you write equations symbolically, define and reference the terms, and show all the gory detail? Or do you write a quick blurb on what you're doing and program the equations into Excel?
3) If someone tells you a number, do you reference the person by name? Some people say that's offensive: that you should "Company ABC said..." instead of "Joe said..."
4) If something is a "rule of thumb" or a number "based on my experience" do you reference it?
5) If you are using third-party software (e.g. simulators, CFD tools, etc.) how do you do the brief? How do you keep track of the what/why of your inputs? How do you make sure your results are valid?
6) How is checking done at your office, and to what level of detail? Is it done properly or does it fall by the wayside?
7) How do you like to check work, your own or someone else's? Do you go over everything with a fine toothed comb, or do you eyeball the numbers, or do the calc a second way and see if the results match?
I realize that the answers all depend on the complexity/novelity/stage of the design cycle you're in.
Thanks in advance.