Re: Mac Documentation: Venting

[Phil <philstokes03 -at- googlemail -dot- com>]

Richard's is eminently the clearest, though I'm not fond of 'Step 3', personally. 

I'd prefer to see the files named:

e.g. 
Step 1....blah blah...
This is the default file; 

Step 2...blah blah...
This is your new customised file. 

Step 3. Make a copy of the customised file. 

Step 4. Replace the default file in root/Library/Applications/Support/Accordance/Preferences with the copy of the customised file.

My second preference is the re-written Mac-style because it separates the instruction from the rationale.

I don't like the original much. It puts both the rationale and the instruction in one sentence and suffers from what I'd called 'stringy sentence syndrome'. Too many things to process in one string. 

Best

Phil

On 22 Jan 2011, at 03:13, Richard Mateosian wrote:

> To make your arrangement of modules in the Library permanent:
> 
> 1. Find the root/Library/Application/Support/Accordance/Accordance
> Preferences folder.
> 
>   This file contains the default arrangement.
> 
> 2. Find the home/Library/Preferences/Accordance Preferences folder.
> 
>    This file contains your arrangement.
> 
> 3. Replace the file found in step 1 with the one found in step 2.
> 
> ...RM
> 
> On Fri, Jan 21, 2011 at 10:49 AM, Deborah Hemstreet
> <dvora -at- tech-challenged -dot- com> wrote:
>> *Based on the Mac Style Guide, I have the following text:
>> 
>> Once satisfied with how modules are arranged in the Library, you backup
>> these preferences for yourself and new users. To do so:Replace the
>> Accordance Preferences folder located in the /Library/Application
>> Support/Accordance folder in your root folder with the Accordance
>> Preferences folder located in the Library/Preferences folder in your home
>> folder.
>> If the User Preferences in your home folder are deleted for any reason, the
>> modules and their arrangements will be restored from the folder in your root
>> folder.
>> 
>> ===================
>> Is the Mac mentality that different. I've written it and this is less clear
>> than the original text:
>> 
>> *
>> 
>> Once satisfied with how modules are arranged in the Library, you can replace
>> the Accordance Preferences folder located in /Library/Application
>> Support/Accordance/ with the folder of the same name located in the
>> Users/UserName/Library/Preferences, as a backup, as well as for new users.
>> 
>> If your User Preferences are deleted for any reason, the modules and their
>> arrangements will be restored from the Accordance folder.
>> 
>> ===========================================
>> Anyone have any suggestions?
>> 
>> Deborah
>> 
>> 
>> 
>> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>> 
>> 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 xrmxrm -at- gmail -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/xrmxrm%40gmail.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
>> 
>> 
>> 
> 
> 
> 
> -- 
> 
> Richard Mateosian <xrm -at- pacbell -dot- net>
> Berkeley, California
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> 
> 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 philstokes03 -at- googlemail -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/philstokes03%40googlemail.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
> 

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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