Showing posts with label tech writing. Show all posts
Showing posts with label tech writing. Show all posts

Wednesday, March 26, 2008

how to program the unit


For optimal function place the unit within the range of earthly temperature. Unit controls provide multidimensional functionality for your convenience, depending on Mode. Modes are as follows:

  • Automatic. Pre-program this Mode to cause the unit to automatically not do what you have specified due to pre-programming error on your part.
  • Manual. Program (do not pre-program!) this Mode to cause the unit to not do what you have specified in "real time" due to programming error on your part.
  • Manuel. Program (or pre-program) this Mode to make the unit not do what you have specified in the future (manana). (Update using tilde Mode where available.) Do not intermingle or otherwise mingle with programming in Manual Mode or Automatic Mode.
  • Vibrate/dishwasher. Use this mode to provide sensual delight at inopportune moments such as when Rev. Teabag visits. Vibrates by default, unless another default was specified when in Automatic Mode, or default was disabled when in Manual Mode, in which case the no-default default action as specified by the no-default default action menu item, is initiated. The default no-default default action is to wash the dishes.
  • Plagiarism detection. Vibrate, emit gong sound (ed.: check for existence of name of sound emitted by struck gong) or wash dishes, depending on default setting, if reference to Rev. Teabag is detected to be plagiarized.
Failure to specify Mode prior to programming will initiate "Modeless" Mode in which results are not guaranteed.

Batteries are not included with the unit. Obtain and insert batteries upon arrival of the unit. Replace batteries before suboptimal performance of the unit manifests in the physical realm. Replacement batteries are unavailable unless otherwise specified. Replace only with batteries approved by the Dept. of Usuriously Overpriced Replacement Parts. Use of non-approved, disapproved or unapproved batteries will void the warrantee unless otherwise specified.

Replacement of flange, flywheel, gasket or rotational cog interface will likewise void the warrantee of the unit unless the warrantee has been voided already for other reasons in which case the result is moot. See The Warrantee of the Unit, Sections 1.1 through 27.12 and Section 27.16 "Cases in which actions that would normally void warrantee are moot".

Do not lose the unit. Loss of unit reduces functionality and is not covered in the warranty. If unit is lost proceed as follows: 1. Find the unit. 2. Do not re-lose the unit.

Warning: Contents of the unit may be hot! In cases in which the unit has contents, which may be hot. Applies only to certain models except where otherwise specified in which case, applies to all models.

Wednesday, May 24, 2006

GlassFish terminology update


When last we visited the GlassFish site in December, I complained that it was not clear what GlassFish actually was--a community, a project, a server? It seemed to be all of those things and yet...if you downloaded, installed, and started the server, the term "GlassFish" never appeared within it, leading you to wonder if you installed the right thing. Uh, didn't I just install "GlassFish"? Why doesn't it say "Glassfish" anywhere?

I also suggested that what the so-called GlassFish download actually downloads, namely the "Sun Java System Application Server Platform Edition 9.0", is ridiculously named. I suggested instead the "Sun Jas9".

Here five months later is progress, of sorts. GlassFish is still a project and a community. Now it's a technology too! But at least they no longer refer to it as a thing unto itself. The term is now correctly used only as an adjective. That is, they no longer talk about downloading or installing "GlassFish". Instead they say things like "this is the place to download general distribution releases related to Project GlassFish", and they refer to the above ridiculously-named thing as the "SJSAS PE 9.0", which doesn't exactly roll off the tongue but they have to keep their precious "Sun Java" coupled in there, even if it makes the acronym unpronounceable thus useless.

Still, their attempts at explaining themselves remain terrible. On the new GlassFish page is this at the bottom:

Sun Microsystems, the inventor and leading advocate of Java technology, is releasing a preview of the Java EE 5 SDK . the next generation of enterprise Java which includes(1) the Beta version of the Sun Java System Application Server PE 9.0 (SJSAS PE 9.0). The SDK is a defining release because the newest version of enterprise Java makes building robust, scalable enterprise applications easier than ever and is the perfect platform for implementing SOA and Web 2.0 applications. The Java EE 5 SDK is built on(2) the SJSAS PE 9 which is based on the bits developed by the open GlassFish community, led by Sun, who is developing an open source Java EE 5 application server(3).

So:
  1. (1) The Java EE 5 SDK includes a beta version of the server (SJSAS PE 9.0)
  2. (2) The Java EE 5 SDK is built upon the SJSAS PE 9.0, which means it is built on a subset of itself. This is the software equivalent of being your own grandpa. Try to draw a picture of it.
  3. (3) Sun is developing an open source Java EE 5 application server. What, another one, in addition to the SJSAS PE 9.0? No, not a different one--the same one they just mentioned at the beginning of this same sentence!

The downloads page claims that the GlassFish project is an implementation of the Java EE 5 specs. But a project cannot be an implementation of anything. Elsewhere on the page they get it right: the GlassFish community provides milestone builds that implement the current version of the spec.

Friday, March 10, 2006

noun string contest

A noun string is too many nouns strung together as adjectives. They are a classic example of bad writing, because you can't keep track of what modifies what, so can easily lose your way in the sentence. Sun and Open Source documents are littered with these. Here's the reigning champ:

the Sun Java System Application Server Platform Edition 8 runtime deployment descriptor

The tech writers at Sun must toil under the heavy shadow of some lawyer-inflated style guide, and readability be damned. They're so afraid somebody will hijack the word "Java" that they say "Sun Java" every time. Yea we get it, you invented Java. And what about "Platform"--what is that? Isn't it enough to just say server? Isn't a server a platform that applications run on? And "System" is pointless--it adds no value. So all of this:

the Sun Java System Application Server Platform Edition 8

...is just a long way of saying:

the Java Application Server

As for the edition, is there an Edition 7? An Edition 9? Do you really need a different runtime deployment descriptor for each edition? Isn't it just version info--you only need it under the "About" in the help menu, you shouldn't put it in the name of the thing.

But if indeed the version is somehow critical, how about an acronym? The Sun JAS8! Guess not--lawyers are fainting, left and right. If an acronym is too racy, then here is an improvement that jettisons the version number, the pointless "system", and the redundant "platform", for the sake of readability. It's still too long, but breaks up the noun strings with a helping preposition at least:

the runtime deployment descriptor for the Java Application Server

Too simple?

------------------------------------------------------------------------------
Runner up:

this Sears MasterCard Choice Rewards Certificate coupon...

Not a mere certificate or coupon, but a Certificate coupon!

Thursday, December 22, 2005

before you begin--oops, too late!

This summary is not available. Please click here to view the post.

Thursday, December 15, 2005

the GlassFish breathmint floorwax dilemma

After a couple of months I have begun to dip my handsome new toe back into Java. It's a world where words mean anything--how I missed it!

"GlassFish", for example. What is it, exactly? Go to the GlassFish page and figure it out.

First, the page header is "GlassFish Community" but you are in the Projects tab, not the Communities tab. You might think, naive you, that they would explain what it is, not who they are. (A rude secret: I do not give a shit who they are--I only want to know what it is!) They are a community! But it looks like a project--there's a button on the left after all, that says GlassFish Project Home. Maybe it'll say what it is there! Click on it and surprise, it goes back to the page you're already on, the community page! So I guess it's a project, about a community, that is building a server.

Maybe the FAQ will explain what it is. Hmm the first question is not what is it, which would seem to me to be frequent question Number One, but rather, where can I get it. [12/17/05 Since modified! Now they say, What is Project GlassFish? first--still not What is GlassFish, but closer.] No worries, I see on the FAQ, a "New to GlassFish" link. I'm new--I want to know what it is. Follow this link and hmm...this link says it's a project, after all. I can introduce myself to others participating in the GlassFish project, I can become a part of it, I can even request a feature!

The GlassFish project provides a structured process...

So, I know that its community is building a server, and its project is providing a process. I just don't know what it is.

Let me click on the Communities tab at the top, to get my bearings. To see a list. At right is the list of communities but what's this--GlassFish is not listed! Ack where the hell am I? Thank goodness for the Back button.

Of course, I am being coy with you! I know what it is--it's an application server. They re-use the name of the community, and the project, for the actual thing. And not just any server, but an "Open Source Java EE 5 Application server". Which I installed. At least I think I did. When I run the server, the title is:

Sun Java System Application Server Platform Edition 9.0

Uh...did I do it right? Do they have enough goddam nouns in there? Sun is the noun string champion. "Platform Edition"--what's that? Is it like the "Platinum Edition"? Is this in fact "GlassFish"? If so why doesn't it say so? Otherwise why did they bother to call it GlassFish in the first place? Where's the little fish logo? And on the bottom of the Welcome page is a link to Project GlassFish "Sun's open source application server", with no acknowledgement that this is that server! Isn't it?

Oh how I remember now, why I fled screaming from these semantic tanglers. Where Apache is a software foundation, a project, and a web server and it's up to you to figure out which one they're talking about at any given moment. How about "Apache Tomcat"! It's why so many people think Tomcat "runs on" Apache. Why isn't it "Jakarta Tomcat"--it wouldn't be confusing enough?

How can such brilliant people be so lousy at explaining themselves? Why are they so willing to attach the name to the community and the project, and so timid about attaching the name to the only thing that actually matters. Come on then, out with it. It's: the GlassFish Application Server! And put the name in the product! If GlassFish is not its name, then don't call it that in the install, and toss it on the dustheap of useless terms like "Jakarta".

Here is my suggestion. The most important information to convey about a thing is, what is it. Not who are the nice people in the community that builds it, and not that the project provides the nice process that helps you build it. But, WHAT IS IT. Say that first.