Just Write Click

Technical writing with Continuous Integration and docs-as-code

  • JustWriteClick
  • Contact
  • Books by Anne Gentle
  • Introducing Docs Like Code
You are here: Home / talk.bmc / Specifications are important, or are they?

November 15, 2005 by annegentle

Specifications are important, or are they?

Lately I’ve seen several good articles or tidbits about specifications and was surprised to see some hatred for them

You know, specs. That short little list of things that is supposed to be the technical description of a product. I just read this New York Times article of the commandments to electronics manufacturers and it’s good stuff. Several of the commandments are directly related to documentation, and to troubleshooting, but sometimes the documentation is used before the purchase, such as reading the specs on a digital camera.

As Gizmodo points out, and Commandment III also describes, sometimes megapixels aren’t the whole story.

“III. Thou shalt not hype irrelevant specs. The digital camera industry wants us to believe that a camera’s quality is somehow related to its number of megapixels. A seven-megapixel camera must be better than a four-megapixel one, right?

It’s the same with computers, where millions of people still believe that the higher a computer’s megahertz, the faster it runs. (To its credit, Intel has recently started playing down that simplified statistic.)”

For digital cameras, the sensor size, which collects the light for the image, limits the sensor’s ability to get the whole picture, so to speak. So a 10-megapixel Sharp camera with a CCD sensor of only 38 square millimeters compared to a 10-megapixel Canon 1DS Mark II with a full-frame sized sensor of 864 square millimeters, well, you just can’t compare on megapixels alone because one the sensors will collect a lot more light for you. It seems as though there’s an hype encroachment even on technical specifications where you have to educate yourself just enough to know which specs matter and which ones don’t.

My other favorite commandment from this list is:

“I. Thou shalt not entomb thy product in indestructible plastic.”

With the holiday season coming up, I don’t look forward to the battle with toy packaging. We plan to unbox (debox?) every toy before wrapping in gift wrap. With the twist ties, zip ties, and extremely sticky tape that binds toys to their display box, it’s always a struggle to free the toy from its temporary home.

Back to specifications. Both as a writer and a consumer, I solemnly swear to examine all specifications for hype, and de-hype them before documenting them for a customer or making a purchase as a customer.

Related

Filed Under: talk.bmc Tagged With: Canon 1DS Mark II, CCD sensor, digital cameras, evaluating electronics, megapixel, usability

More reading

Bubble graph showing sources of developer support data

I’ve been thinking a lot about developer support at Cisco recently, especially for the way the world works today with multiple cloud providers. This post is a re-publish of my talk from over five years ago, but the techniques and tools for listening and helping others are still true today. At Rackspace, we watched several […]

Cisco DevNet is our developer program for outreach, education, and tools for developers at Cisco. From the beginning, the team has had a vision for how to run a developer program. Customers are first, and the team implements what Cisco customers need for automation, configuration, and deployment of our various offerings. Plus, the DevNet team […]

I had a great talk with Ellis Pratt of Cherryleaf Technical Writing consulting last week. Here are the show notes, full of links to all the topics we covered. Podcasts are great fun to listen to and participate in, if a bit nerve-wracking to think on your feet and make sure you answer questions succinctly […]

At the beginning of this year, I worked hard to summarize my thoughts on API documentation, continuous publishing, and technical accuracy for developer documentation. The result is an article on InfoQ.com, edited by Deepak Nadig, who also was forward-thinking in having me speak to a few teams at Intuit about API documentation coupled with code. Always […]

Recently on Just Write Click

  • A Flight of Static Site Generators: Sampling the Best for Documentation
  • Try a GPT about “Docs Like Code” to ask questions
  • Discipline and Diplomacy: Docs in the Open
  • Let’s Find Out: When Do Static Site Generators Do Rendering?
  • GitHub for Managing Tech Docs

Just Write Click in your Inbox

Enter your email address to subscribe to Just Write Click and receive notifications of new posts by email.

Read More

  • Privacy Policy
  • About Anne Gentle, developer experience expert
  • Books by Anne Gentle
    • Conversation and Community
    • Docs Like Code, a Book for Developers and Tech Writers
  • Woman in Tech Speaker Profile
  • Contact

Books

  • JustWriteClick
  • Contact
  • Books by Anne Gentle
  • Introducing Docs Like Code

Copyright © 2025 · WordPress · Log in