Re: Expressing SQL in Design Doc

Subject: Re: Expressing SQL in Design Doc
From: bcliver -at- manu -dot- com
To: "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Thu, 21 Oct 2004 11:43:25 -0400

>Right. Keep in mind, as my example showed, the question is not whether to
>capitalize KRWs in code but in narrative paragraphs.

>My question was, to SQL developers, how would they _expect_ to see the
>keywords & reserved words (KRWs) expressed in explanatory text? So I went
>to my main research facility for this type of question: Barnes & Noble ;)

>Anyway, in a few third-party PL/SQL books, they cap all the KRWs...but in
>a SQL book I skimmed, they capitalized only the initial letter of the
>So, I've decided to cap all KRWs in my doc.

The number of reserved words for particular database vendor like Oracle is
quite small. I think the DB2 list is somewhat longer. Are the KRWs defined
by your company's schema? If not, I would just refer users to the vendor

Using a unique font/style is a good way to distinguish database objects in

Barry Cliver
Lead Technical Writer


ROBOHELP X5: Featuring Word 2003 support, Content Management, Multi-Author
support, PDF and XML support and much more!

WEBWORKS FINALDRAFT: New! Document review system for Word and FrameMaker
authors. Automatic browser-based drafts with unlimited reviewers. Full
online discussions -- no Web server needed!

You are currently subscribed to techwr-l as:
archiver -at- techwr-l -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- techwr-l -dot- com
Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit for more resources and info.

Previous by Author: Re: Blogging software-your opinions
Next by Author: Re: a different resume red flag
Previous by Thread: Re: Expressing SQL in Design Doc
Next by Thread: Calendar Temporarily Live

What this post helpful? Share it with friends and colleagues:

Sponsored Ads