Breaking News
Comments
Newest First | Oldest First | Threaded View
<<   <   Page 2 / 2
kfield
User Rank
Author
Crap, more crap, and even more crap
kfield   5/19/2014 1:23:34 PM
NO RATINGS
I can't pretend that I have any good methods for capturing and maintaining documentation, but I do love the file management system an engineering friend of mine has: I was leaning over his shoulder recently while he was working on his laptop and I noticed he had three folders on his desktop: crap, more crap, and even more crap. He told me that was where he stored the "important" content!

DrQuine
User Rank
Author
Creation and retrieval of documentation
DrQuine   5/16/2014 4:47:00 PM
NO RATINGS
The challenge of documentation is that it is usually intended for retrieval in the future. This means that the effort of documentation has little immediate reward and the future retrieval depends upon maintaining access integrity through time. Three ring binders are bulky and hard to search but admirable in their accessible user interface through time, changing computer software, and operating system. Computer files must be created in a format for which future access is assured and the files must be rolled ahead to each new generation of the storage system.  They must also be preserved in a way that is obvious to others.  Most computers are reused or retired when their owners retire or pass away. Few files are effectively captured and mined for the corporate benefit. Lab books are visible which at least forces somebody to consciously decide whether to preserve or discard them. Someday, our ability to create data will be matched by our ability to mine it. In the meantime, most recollections of previous solutions depend upon the memory of the inventor; the documentation merely fills in the fine details. The next generation has little hope of mining the digital records of their predecessors. 

spike_johan
User Rank
Author
Engineering Documentation
spike_johan   5/16/2014 3:54:55 PM
NO RATINGS
There is a saying in the engineering world - specifically test engineering - "If you didn't write it down, you didn't do it."

 

betajet
User Rank
Author
"Hello, this is Deadly Binders, Inc. How may I injure you?"
betajet   5/16/2014 2:21:13 PM
NO RATINGS
I use a lot of 3-ring binders, so many it's hard to store them all.  I don't use them for everything.  For day-to-day notes and planning, I far prefer college-ruled composition books with "granite" covers.  They're a nice size, light, and easy to take on public transportation.  I carry them everywhere.

I'm also a strong believer in documentation -- the earlier the better.  When I'm working on something new and don't know what I'm doing yet, the notebook is excellent.  However, once I can start to describe it I find that writing it up using a document editor is a great way to get the ideas filled in, and it becomes the first draft of the eventual documentation.  The hard copy goes in binders.

I find it very hard to proof-read on a screen.  I always find errors after printing out on paper.

IMO everyone should print hard copy listings of their software and technical references.  If doing so creates so much paper that you can't manage, then your design approach clearly needs to be reconsidered.

JMO/YMMV

zeeglen
User Rank
Author
Write everything down - absolutely everything.
zeeglen   5/16/2014 9:14:37 AM
NO RATINGS
The days of bound engineering lab notebooks (for patent purposes) that would no longer close due to being stuffed full of Polaroid scope photos are long gone, binders do help solve this.

These days keep all your design notes and measurements on a computer.  This way you can search for some long-forgotten entry based on a vaguely remembered keyword, and disseminate your notes through email instead of a photocopier. (Patent lawyers might not agree with this philosophy, makes it too easy to fake the dates.)

The main thing is to write everything down.  You never know what you may need at some future time.

wave.forest
User Rank
Author
Very nice
wave.forest   5/16/2014 8:05:03 AM
NO RATINGS
Document the first project, document the new job, document everything new will save you a lot of time and hassles.

<<   <   Page 2 / 2


Datasheets.com Parts Search

185 million searchable parts
(please enter a part number or hit search to begin)
Like Us on Facebook
Special Video Section
LEDs are being used in current luxury model automotive ...
With design sizes expected to increase by 5X through 2020, ...
01:48
Linear Technology’s LT8330 and LT8331, two Low Quiescent ...
The quality and reliability of Mill-Max's two-piece ...
LED lighting is an important feature in today’s and future ...
05:27
The LT8602 has two high voltage buck regulators with an ...
05:18
Silego Technology’s highly versatile Mixed-signal GreenPAK ...
The quality and reliability of Mill-Max's two-piece ...
01:34
Why the multicopter? It has every thing in it. 58 of ...
Security is important in all parts of the IoT chain, ...
Infineon explains their philosophy and why the multicopter ...
The LTC4282 Hot SwapTM controller allows a board to be ...
This video highlights the Zynq® UltraScale+™ MPSoC, and sho...
Homeowners may soon be able to store the energy generated ...
The LTC®6363 is a low power, low noise, fully differential ...
See the Virtex® UltraScale+™ FPGA with 32.75G backplane ...
Vincent Ching, applications engineer at Avago Technologies, ...
The LT®6375 is a unity-gain difference amplifier which ...
The LTC®4015 is a complete synchronous buck controller/ ...
10:35
The LTC®2983 measures a wide variety of temperature sensors ...