Embedded Systems Conference
Breaking News
Newest First | Oldest First | Threaded View
<<   <   Page 2 / 2
User Rank
Crap, more crap, and even more crap
kfield   5/19/2014 1:23:34 PM
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!

User Rank
Creation and retrieval of documentation
DrQuine   5/16/2014 4:47:00 PM
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. 

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


User Rank
"Hello, this is Deadly Binders, Inc. How may I injure you?"
betajet   5/16/2014 2:21:13 PM
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.


User Rank
Write everything down - absolutely everything.
zeeglen   5/16/2014 9:14:37 AM
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.

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

<<   <   Page 2 / 2


NASA's Orion Flight Software Production Systems Manager Darrel G. Raines joins Planet Analog Editor Steve Taranovich and Embedded.com Editor Max Maxfield to talk about embedded flight software used in Orion Spacecraft, part of NASA's Mars mission. Live radio show and live chat. Get your questions ready.
Brought to you by

Like Us on Facebook

Datasheets.com Parts Search

185 million searchable parts
(please enter a part number or hit search to begin)
Special Video Section
The LTC®4015 is a complete synchronous buck controller/ ...
The LTC®2983 measures a wide variety of temperature sensors ...
The LTC®3886 is a dual PolyPhase DC/DC synchronous ...
The LT®3042 is a high performance low dropout linear ...
Chwan-Jye Foo (C.J Foo), product marketing manager for ...
The LT®3752/LT3752-1 are current mode PWM controllers ...
LED lighting is an important feature in today’s and future ...
Active balancing of series connected battery stacks exists ...
After a four-year absence, Infineon returns to Mobile World ...
A laptop’s 65-watt adapter can be made 6 times smaller and ...
An industry network should have device and data security at ...
The LTC2975 is a four-channel PMBus Power System Manager ...
In this video, a new high speed CMOS output comparator ...
The LT8640 is a 42V, 5A synchronous step-down regulator ...
The LTC2000 high-speed DAC has low noise and excellent ...
How do you protect the load and ensure output continues to ...
General-purpose DACs have applications in instrumentation, ...
Linear Technology demonstrates its latest measurement ...
Demos from Maxim Integrated at Electronica 2014 show ...
Bosch CEO Stefan Finkbeiner shows off latest combo and ...