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.
> Is there any prescribed way to use slashes at the end of a path?
> For example, if I want to tell users to place a file inside the bin
> directory, which treatment of slashes is preferred:
>
> Save install.exe in <install dir>/bin/
> Save install.exe in <install dir>/bin
I don't know about "prescribed" (he said, not
bothering to hunt up his copy of the MS or SUN
style guide), but I prefer the final slash
(or backslash for Windows). Without it, I expect
the final characters to be a filename.
It's usually easy to tell from context what is intended
or expected, but it takes that additional moment of
thought, that "increased cognitive load" that doesn't
add any value to the user. So I figure if it's as
easy as including a terminating slash to make it
unambiguous, why not?
In my docs, if the last item in a path is a directory
(or folder...) I finish with a slash or backslash.
- k
The information contained in this electronic mail transmission
may be privileged and confidential, and therefore, protected
from disclosure. If you have received this communication in
error, please notify us immediately by replying to this
message and deleting it from your computer without copying
or disclosing it.
Create and publish documentation through multiple channels with Doc-To-Help.
Choose your authoring formats and get any output you may need. Try
Doc-To-Help, now with MS SharePoint integration, free for 30-days. http://www.doctohelp.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-
