HOME  |  NEWS  |  BLOGS  |  MESSAGES  |  FEATURES  |  VIDEOS  |  WEBINARS  |  INDUSTRIES  |  FOCUS ON FUNDAMENTALS
  |  REGISTER  |  LOGIN  |  HELP
Comments
View Comments: Newest First|Oldest First|Threaded View
<<  <  Page 2/3  >  >>
Jon Titus
User Rank
Blogger
Re: Documents and manuals need an index
Jon Titus   8/15/2012 12:50:47 PM
NO RATINGS
Old_Curmudgeon: I second your complaints about part numbers and descriptions in print catalogs and online catalogs.  Even the manufacturers of products screw up part numbers and call something an ABC-123 in a press release when the true part number looks something like ABC12x, where x can represent several part families and they have dropped the hyphen.  This situation comes up more often than people might think.

OLD_CURMUDGEON
User Rank
Platinum
Re: Documents and manuals need an index
OLD_CURMUDGEON   8/15/2012 12:43:16 PM
NO RATINGS
Jon,

There are several other (print) catalogs that I rate very highly also, including the GRAINGER catalog, the MSC INDUSTRIAL SUPPLY catalog, and several electronic supply catalogs (MOUSER, ALLIED, NEWARK, to name a few).  Mentioning the McMASTER CARR catalog was just a "for instance" moment.  But, I can tell you one thing, and maybe this is because of my age, I usually get VERY frustrated searching manufacturers' wesite-based catalogs.  More often than not, the format of a part number in their e-database is different from the way it is printed on the item, OR as it appears in a (print) catalog.  One can be driven to total distraction because of a misplaced emdash, or other diacritical mark!  And, my final "beef" is that with print catalogs, I can make notes in the margins, circle important data parameters, etc.  Unless I print a page from the online catalogs, I have to make some other arrangement to store that info in the project folders. 

Ann R. Thryft
User Rank
Blogger
Re: Documents and manuals need an index
Ann R. Thryft   8/15/2012 12:32:19 PM
NO RATINGS
I agree with Jon about the need for manuals to include cross-references, or better yet, a glossary that defines terms and indicates which terms mean the same thing. That would be a huge help.

Ann R. Thryft
User Rank
Blogger
Re: Two mistakes save the day
Ann R. Thryft   8/15/2012 12:27:40 PM
NO RATINGS
You're right about that. I was thinking of more complex problem-solving and/or assembly projects. OTOH, I generally use the same approach even when putting together furniture--yes I still use those, all bookshelves--even though I'm really familiar with all the screw and connector types, and generally what can go wrong.

Rob Spiegel
User Rank
Blogger
Re: Two mistakes save the day
Rob Spiegel   8/15/2012 12:21:08 PM
NO RATINGS
I think a lot of this depends on what you're working on. In the description of the systems Jon Titus describes, instructions are critical. When I'm putting together toys for the kids, it's pretty intuitive.

Ann R. Thryft
User Rank
Blogger
Re: Two mistakes save the day
Ann R. Thryft   8/15/2012 12:15:46 PM
NO RATINGS
Rob, it's preventive medicine and hindsight. I had some experiences way back where I did the dive-in approach and was not happy with the results. Doing things over due to lack of preparation or foresight is not my idea of fun. It's much more fun and challenging to concentrate on solving the problem, or finishing the assembly, than stopping multiple times to move the project, or go to the hardware or electronics store for parts. I know some things, like plumbing repairs, by definition require multiple iterations in terms of part sizes or types. So those go to a plumber (or my husband).

Jon Titus
User Rank
Blogger
Re: Documents and manuals need an index
Jon Titus   8/15/2012 11:16:50 AM
NO RATINGS
Thanks for your comment.  I'll have to get a copy of the McMaster Carr catalog and take a look. --Jon

OLD_CURMUDGEON
User Rank
Platinum
Re: Documents and manuals need an index
OLD_CURMUDGEON   8/15/2012 8:42:59 AM
NO RATINGS
Jon,

One of the BEST "books" containing an index is the McMASTER CARR SUPPLY catalog.  There is so much redundancy that it is almost sickening, but as was posted, one person's widget might be someone else's doohickey.  Nevertheless, they both exist in that index.  Sure makes life a lot easier when poring through a catalog of 5,000 + pages.

Jon Titus
User Rank
Blogger
Documents and manuals need an index
Jon Titus   8/14/2012 7:03:26 PM
NO RATINGS
Manuals should have a good index with cross references.  What someone thinks of as a temperature sensor, someone else might think of as a temperature switch or temperature detector.  So listing all three in an index helps people get to the information no matter what they call something. Indexing requires patience and thoroughness.

I find the lack of cross references particulary troublesome in software books and documents.  In a C-language reference book I use often, I find two references to hexadecimal numbers and hex numbering in the index. But no reference to how to format data to display it in as hex values. In a perfect world, the index would include: 

hexadecimal, printing of

hexadecimal, display of

Under the heading of printf my book's index points to pages about printing floating-point numbers and strings, but nothing about other formats such as scientific notation or octal. An index makes or breaks documentation.

Jon Titus
User Rank
Blogger
Re: Two mistakes save the day
Jon Titus   8/14/2012 6:46:49 PM
NO RATINGS
Debugged might work--it's not used solely for software.

<<  <  Page 2/3  >  >>


Partner Zone
Latest Analysis
Take a look through these film and TV robots from 1990 through 1994.
The Soofa is an urban smart bench that provides mobile device charging as well as collects environmental information via wireless sensors.
Sciaky, provider of electron-beam additive manufacturing (EBAM) services, will start selling these machines commercially in September. The company has used its EBAM 3D printing technology for making very large, high-value, metal prototypes and production parts for aerospace and defense OEMs.
At this year’s Google I/O, the spotlight was pointed on gender inequality in the high-tech industry. Google has established a new initiative that it hopes will even out the playing field, Made w/Code. Part of this initiative will fund free online courses in basic coding.
Self-driving vehicle technology could grow rapidly over the next two decades, with nearly 95 million “autonomous-capable” cars being sold annually around the world by 2035, a new study predicts.
More:Blogs|News
Design News Webinar Series
7/23/2014 11:00 a.m. California / 2:00 p.m. New York
7/17/2014 11:00 a.m. California / 2:00 p.m. New York
6/25/2014 11:00 a.m. California / 2:00 p.m. New York
5/13/2014 10:00 a.m. California / 1:00 p.m. New York / 6:00 p.m. London
Quick Poll
The Continuing Education Center offers engineers an entirely new way to get the education they need to formulate next-generation solutions.
Aug 4 - 8, Introduction to Linux Device Drivers
SEMESTERS: 1  |  2  |  3  |  4  |  5  |  6


Focus on Fundamentals consists of 45-minute on-line classes that cover a host of technologies. You learn without leaving the comfort of your desk. All classes are taught by subject-matter experts and all are archived. So if you can't attend live, attend at your convenience.
Next Class: August 12 - 14
Sponsored by igus
Learn More   |   Login   |   Archived Classes
Twitter Feed
Design News Twitter Feed
Like Us on Facebook

Sponsored Content

Technology Marketplace

Copyright © 2014 UBM Canon, A UBM company, All rights reserved. Privacy Policy | Terms of Service