Avoiding the Hobgoblins

and the foolish consistency they represent.

Flying Flux: The Dullness of Details

I think it behooves writers to make technical documentation fun by embedding a few surprises here and there for the unsuspecting reader. Just like how chip designers used to embed artwork in their chips (I’ve done so myself), writers of technical documents should try to slip in a bit of flowery language from time to time.

For example, let’s look at the following sentence:

Original: Jitter degradation is most sensitive to supply noise between 20 MHz to 80 MHz.

[…]

Simile: The 20-80 MHz supply noise’s effect on the clock edges’ accuracy is like a well-endowed woman doing jumping jacks.