TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
Subject:Re: Expressing SQL in Design Doc From:jsokohl -at- mac -dot- com To:"TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Thu, 21 Oct 2004 09:30:15 -0600
> PL/SQL is _not_ case sensitive (as far as I know) so it does not really
> matter. So capitalizing (or not) is a matter of readablilty and not
> usability.
>
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 KRW.
So, I've decided to cap all KRWs in my doc.
ROBOHELP X5: Featuring Word 2003 support, Content Management, Multi-Author
support, PDF and XML support and much more!
TRY IT TODAY at http://www.macromedia.com/go/techwrl
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! http://www.webworks.com/techwr-l
---
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 http://www.techwr-l.com/techwhirl/ for more resources and info.