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:Expressing SQL in Design Doc From:jsokohl -at- mac -dot- com To:"TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Wed, 20 Oct 2004 12:07:10 -0600
Hi all,
I'm editing some info. Developer gives me description of a PL/SQL
procedure, but he capitalizes all the SQL items in the description of the
flow. I think only the SQL verbs should be capped, but he's got'em all
capped--nouns & verbs.
Example (truncated for proprietary code):
-------------
Create the Batch Employee Program Reference List.
The ROWSET will contain one ROW for each distinct Batch Employee Program
Name and Description from the Batch Employee Table for the group. Each
WHERE clause receives its own....Ensure that each SELECT statement ends in
....
-------------
I'm mostly interested in the ROW and ROWSET. My convention and my
understanding of the appropriate approach would be to capitalize only
words such as WHERE and GET and SELECT, but not words such as row and
rowset and column and so on.
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.