Re: directory and path syntax query
I want to talk about a particular directory (which is relative to a program
What is the appropriate syntax for referring to this directory in a
For a directory that is relative to the directory where our product is installed, I refer to it as
(where PRODUCT_INSTALL is in italics). Somewhere I say:
"... where PRODUCT_INSTALL is the directory where GroovyProduct is installed. If GroovyProduct is installed in its default location, this will be C:\Program Files\Company\Program\."
This allows for cases where customers do not install it in the default location. We also have a number of directories relative to that base directory, so it is handy to have a term to refer to it by. The fact that is shown in italics helps clue people in that its a variable. (At least, it will if they're familiar with the traditional UNIX conventions.)
Just my two cents,
Previous by Author:
Re: Squashed egos... it ain't pretty!
Next by Author: Software documentation on the critical path
Previous by Thread: RE: directory and path syntax query
Next by Thread: RE: directory and path syntax query
Search our Technical Writing Archives & Magazine