RE: Slashes in paths

Subject: RE: Slashes in paths
From: "McLauchlan, Kevin" <Kevin -dot- McLauchlan -at- safenet-inc -dot- com>
To: Karen Felker <akaren -at- earthlink -dot- net>, Tech Writers <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Fri, 29 Jul 2011 09:16:14 -0400



> -----Original Message-----
> From: Karen Felker

> 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-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com


To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/ for more resources and info.

Please move off-topic discussions to the Chat list, at:
http://lists.techwr-l.com/mailman/listinfo/techwr-l-chat


Follow-Ups:

References:
Slashes in paths: From: Karen Felker

Previous by Author: RE: swapping monitors?
Next by Author: RE: Optimizing OnlineHelp for Mobile Viewing
Previous by Thread: Slashes in paths
Next by Thread: Re: Slashes in paths


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

Sponsored Ads


Sponsored Ads