[Bf-docboard] Feedback on Writing Style

Campbell Barton ideasman42 at gmail.com
Tue Jan 6 00:31:19 CET 2015


Gaia, this really has nothing to do with 'Writing Style',

Can you start a new thread for new topics?

On Tue, Jan 6, 2015 at 12:32 AM, Gaia <gaia.clary at machinimatrix.org> wrote:
> Would it be useful to add a "contribute" link
> at a prominent location in the manual ? For example:
>
> http://www.pasteall.org/pic/show.php?id=81986
>
> The "contribute" link could point to a document which
> in turn provides some info about:
>
> - the aims of the manual (why it was moved from the wiki)
> - how to setup the manual development
> - The writers style guide
> - where to get help as a manual writer
> - ...
>
> So that all is in one place and easily accessible especially
> for users who are just stepping in with a fresh mind...
>
> Also would it be useful to update the following page ?
>
> http://www.blender.org/get-involved/documenters/
>
> thanks
> Gaia
>
> On 05.01.2015 13:52, Campbell Barton wrote:
>> Hi there,
>> Recently we've been adding some notes to the 'writing style',
>>
>> Currently its mainly a list of what *not* to do (based on reading the
>> lower quality wiki-manual text).
>>
>> See:
>> https://developer.blender.org/diffusion/BM/browse/master/readme.rst$34
>>
>> But I'd be interested to get feedback from people on this list who
>> have experience technial writing.


-- 
- Campbell


More information about the Bf-docboard mailing list