Design Con 2015
Breaking News
Comments
wave.forest
User Rank
Manager
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.

spike_johan
User Rank
Rookie
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."

 

Anand.Yaligar
User Rank
Rookie
Re: Engineering Documentation
Anand.Yaligar   5/21/2014 6:53:13 AM
NO RATINGS
@Spike_johan: Interestingly, this is what most trainee engineers suffer from in their first couple of years. "If you didn't write it down, you'll forget it" and "If you didn't write it down, you didn't do it". It is through hardship do they understand the importance of physical documentation. Going tech-savvy is good, but in order to build a technology, paper documentation is required.

Anand.Yaligar
User Rank
Rookie
Re: Very nice
Anand.Yaligar   5/21/2014 6:54:26 AM
NO RATINGS
@wave.forest: Not only that, if an engineer is methodical, nobody is going to stop him from reaching high in the company.

zeeglen
User Rank
Blogger
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.

betajet
User Rank
CEO
"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

DrQuine
User Rank
CEO
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. 

Sheepdoll
User Rank
Blogger
Re: Creation and retrieval of documentation
Sheepdoll   5/19/2014 2:07:56 PM
NO RATINGS
@DrQuine - The challenge of documentation is that it is usually intended for retrieval in the future.


What I have found using the smaller one inch binders is that this size works for keeping the quick reference stuff.  The few pages of the data sheet one needs to access quickly like the pinouts and footprints.  I also keep the schematic,  and BOM in these thin binders.  I like to think of these as aking to the "pocket program guide." for easy quick reference.

Size does matter here as I like to reference some of these as a bedside reader.  The photograph was taken literately on my bed.  This size is also useful in the bathroom. Granted one can take the laptop, or phone into the loo (head or necessary)  Given that most of these now have Orwellian cameras on them, I am not sure I want to do that.  Or for this natural engineering and salty sailor talk topic to continue.

@Karen - My folders are quarantine, sandbox and guff.  Then there is the evenMoreGuff folder.   Disks and now thumb drives that I sneaker net with are called Noah, and ark.  These then go into quarantine.

 

kfield
User Rank
Blogger
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!

betajet
User Rank
CEO
Re: Crap, more crap, and even more crap
betajet   5/21/2014 9:30:36 AM
NO RATINGS
From Tennessee Williams' Camino Real:
Gypsy: This filing system is screwed up six ways from next Sunday... File this crap under crap!

Who would have guessed that TW would know so much about engineering records?

Anand.Yaligar
User Rank
Rookie
Re : Engineering’s Three Rules: Document, Document, Document
Anand.Yaligar   5/21/2014 6:51:51 AM
NO RATINGS
I like to document my work with the help of a simple technique: locality of reference. This means that I keep at hand those things that have equal importance to a project, even if I don't use them. Not only that, I label each section using the alphabets A,B,C etc, and write a summary of contents on top of every label. If I need a document on Software Post Processing that has been labelled in "T" and if the topics Software String Management in "Z" and Software Code Debugging Models in "R" are equally important to the project (even if they are not needed), I group the labels T,Z and R together. 

kfield
User Rank
Blogger
Managing email?
kfield   8/31/2014 9:32:03 PM
NO RATINGS
Do you have any recommendations for how to keep your emails filed? I feel overwhelmed and I don't manage it as well as I know I could/should.

Sheepdoll
User Rank
Blogger
Re: Managing email?
Sheepdoll   8/31/2014 11:55:44 PM
NO RATINGS
I like using thunderbird.  This allows for multiple accounts and lots of sub folders.  For mailing lists, I have search patterns which sort the list into it's own digest folder.

Thunderbird sets up a local fork, which is an accountless email client. Useful when working with IMAP hosts.  It is also possible to set up additional headless POP accounts.  Works good for archival mail.

Sent and received messages can be copied to these headless account folders, where little icon allows the correspondence to be see in a threaded view.

I keep a folder named sync, for temporary messages or when I am traveling and need to download emails.

 

 

David Ashton
User Rank
Blogger
Re: Managing email?
David Ashton   9/1/2014 12:37:11 AM
NO RATINGS
@Karen... "Do you have any recommendations for how to keep your emails filed..?"

I don't, but I recall Max did a blog about it some time ago, and after a bit of searching I found it:

http://www.eetimes.com/author.asp?section_id=36&doc_id=1285089

Fortunately I am not as famous as you or Max so I don't need to think about this sort ot thing, but Max seems to have found a good solution.  This was in 2011 so maybe we should ask him to update his experiences...Max??

Max The Magnificent
User Rank
Blogger
Re: Managing email?
Max The Magnificent   9/2/2014 11:43:00 AM
NO RATINGS
@David: This was in 2011 so maybe we should ask him to update his experiences...Max??

It's strange that something as ubiquitous as emaisl shoudl cause so many problems. For my personal emails I'm still using the same scheme you mentioned. I have a Google Apps account that gathers all of my email messages from the various accounts that seem to poliferate over the years. I use Outlook and Google Sync on all my personal machines, which means that all of the machines always re-sync when I power them up (and keep resyncing whilst powered up) and any actions like email messages that I send, receive, delete, whatever on one machine are replicated on all of the others.

I also have my UBM/EETimes notepad with my max.maxfield@ubm.com email account -- that has to be handled seperatly (sad face)

LiketoBike
User Rank
CEO
All of it...
LiketoBike   12/11/2014 1:04:20 PM
NO RATINGS
@Julie, nice article.  I think I do all of it...


I keep an engineering notebook.  In it are meeting notes, phone call notes, and some engineering drawings and scribbles.

I keep one or more three-ring binders for a given project.  Number and size depend on size and duration of said project.  Often-referred-to data sheets, drawings, plots from test equipment, lengthy derivations, photocpies of a critical page from a book, printouts of key journal papers...

I also keep a project folder on the PC with many directories.  I try to divide a project up into logical sub-folders.  There will be folders for data sheets, relevant papers (with sub-folders for topical organization), documents (reports, proposals, presentations, etc), overhead stuff (like pdfs of orders and receipts), cad files, and folders for individual cad tools (one for spice, one for microwave circuit simulator, one for 3D field simulator, one for firmware, etc, etc).  One for photos - I take a lot of pictures of things with my phone to go into reports and presentations.  Others for special purposes that make their need known when they show up.

The notebooks stay on my shelf, except for the current one, which goes with me everywhere.  The binders generally stay in the office, except for the small one with currently-used stuff, which typically travels with me to meetings and home at night.  The PC gets backed up onto a server AND a desktop hard drive. 

Finally, my laptop is heavy since I don't have a desktop.  I don't always like dragging it home.  So I have files I may be currently working on (a proposal or a drawing or a simulation) also on a thumb drive, and schlep that back and forth so that I can get some work done off site without dragging the whole PC around.

Finding things again is key.  On the PC I can search.  In binders, I use dividers and label them for organization.  Key things are at the front of the binder, and may get individual sticky notes/tabs.  I have been known to use those also in my lab engineering notebook, and I summarize critical and frequently used information on the back page.

This whole mess has been evolving ever since I started designing anything, even before I went to college, and it just continues to change as the tools of our profession change.



Top Comments of the Week
Flash Poll
Like Us on Facebook

Datasheets.com Parts Search

185 million searchable parts
(please enter a part number or hit search to begin)
EE Life
Frankenstein's Fix, Teardowns, Sideshows, Design Contests, Reader Content & More
Max Maxfield

Tired Old iPad 2 vs. Shiny New iPad Air 2
Max Maxfield
6 comments
I remember when the first iPad came out deep in the mists of time we used to call 2010. Actually, that's only four years ago, but it seems like a lifetime away -- I mean; can you remember ...

<b><a href=Betajet">

The Circle – The Future's Imperfect in the Present Tense
Betajet
5 comments
The Circle, a satirical, dystopian novel published in 2013 by San Francisco-based writer Dave Eggers, is about a large, very powerful technology company that combines aspects of Google, ...

Martin Rowe

Make This Engineering Museum a Reality
Martin Rowe
Post a comment
Vincent Valentine is a man on a mission. He wants to make the first house to ever have a telephone into a telephone museum. Without help, it may not happen.

Rich Quinnell

Making the Grade in Industrial Design
Rich Quinnell
16 comments
As every developer knows, there are the paper specifications for a product design, and then there are the real requirements. The paper specs are dry, bland, and rigidly numeric, making ...

Special Video Section
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 ...
10:29
Demos from Maxim Integrated at Electronica 2014 show ...
Bosch CEO Stefan Finkbeiner shows off latest combo and ...
STMicroelectronics demoed this simple gesture control ...
Keysight shows you what signals lurk in real-time at 510MHz ...
TE Connectivity's clear-plastic, full-size model car shows ...
Why culture makes Linear Tech a winner.
Recently formed Architects of Modern Power consortium ...
Specially modified Corvette C7 Stingray responds to ex Indy ...
Avago’s ACPL-K30T is the first solid-state driver qualified ...
NXP launches its line of multi-gate, multifunction, ...
Doug Bailey, VP of marketing at Power Integrations, gives a ...
See how to ease software bring-up with DesignWare IP ...
DesignWare IP Prototyping Kits enable fast software ...
This video explores the LT3086, a new member of our LDO+ ...
In today’s modern electronic systems, the need for power ...