Re: [libreoffice-documentation] Docs for tech writers - first draft posted

[Gary Schnabl <gSchnabl@SWDetroit.com>]

On 11/15/2010 12:50 AM, Daniel Friedman wrote:
> Hi everyone,
> Thanks for all your comments so far. Our first draft for the docs for 
> tech writers is posted at:
> http://wiki.documentfoundation.org/File:Guide_for_technical_writers-draft.odt 
>
> We know there are still some inconsistencies, and we're working for 
> the next two days to iron them out for our final version due on 
> Wednesday. Unfortunately, we've also had to cut a few sections out 
> from our original outline due to the length constraints of our 
> assignment.
>
> Let us know if you have any comments about the doc.
>
> - Dan

I performed a very rapid copyedit of the doc and parked it on one of my 
inactive websites: 
http://swdetroit.com/Guide_for_technical_writers-draft_edit.odt, in case 
anybody might be interested. I did not try downloading it as a check of 
my uploading it correctly, but it should be OK.

The doc has some inconsistencies, where two different versions of 
various items were used. Perhaps, you should employ just one form 
throughout.

The headings employed headline-style capitalization, whereas 
sentence-style capitalization might be better. Personal preference, but 
nonfiction typically will use the latter.

Character styles should be used for bolding instead of the formatting 
bar (manual overrides). AFAIK, no such character styles were employed, 
but I only checked a few instances and did not notice any character styles.

--

Gary Schnabl
Southwest Detroit, two miles NORTH! of Canada--Windsor, that is...


--
E-mail to documentation+help@libreoffice.org for instructions on how to unsubscribe
List archives are available at http://www.libreoffice.org/lists/documentation/
All messages you send to this list will be publicly archived and cannot be deleted