← Back to team overview

ubuntu-manual team mailing list archive

Re: Style and content guide

 

I think this is great and should be useful for all content writer/editors. I
also think you have some good points about our target audience that should
be kept in mind, especially for those of us who have been using Ubuntu for
some time where many tasks have become second nature. Keeping it accessible
to those completely fresh to the OS, or those who are less 'tech-savvy' is
important.

Perhaps once we have consensus on how code will be included, it could be
added to this page as well.

Jamin

On Fri, Jan 8, 2010 at 6:03 AM, Ilya Haykinson <haykinson@xxxxxxxxx> wrote:

> The Docs Team's style guide is aimed at a slightly different audience.
> Content that they work on is:
>
>  - task based, rather than an overview
>  - aims to be complete, rather than to present a coherent story for a
> beginner
>  - is written in HTML, and not LaTeX
>
> I certainly think that we should keep both in mind when writing, but some
> of the advice our style guide offers is specific to the differences of our
> workload from pure documentation.
>
> -ilya
>
>
> On Thu, Jan 7, 2010 at 1:46 AM, Kelvin Gardiner <kelvin@xxxxxxxx> wrote:
>
>> Hi,
>>
>> What additional style guidance is needed over the Docs Team's style guide
>> (https://wiki.ubuntu.com/DocumentationTeam/StyleGuide)?
>>
>> Regards,
>> Kelvin
>>
>> Ilya Haykinson wrote:
>>
>>> I've started work on a style / content guide. I'm hoping that we can get
>>> some consensus on this before too much content gets written.
>>>
>>>    https://wiki.ubuntu.com/ubuntu-manual/StyleGuide
>>>
>>> Please feel free to edit/expand.
>>>
>>> -ilya haykinson
>>>
>>> ------------------------------------------------------------------------
>>>
>>>
>>> _______________________________________________
>>> Mailing list: https://launchpad.net/~ubuntu-manual<https://launchpad.net/%7Eubuntu-manual>
>>> Post to     : ubuntu-manual@xxxxxxxxxxxxxxxxxxx
>>> Unsubscribe : https://launchpad.net/~ubuntu-manual<https://launchpad.net/%7Eubuntu-manual>
>>> More help   : https://help.launchpad.net/ListHelp
>>>
>>>
>>
>>
>> _______________________________________________
>> Mailing list: https://launchpad.net/~ubuntu-manual<https://launchpad.net/%7Eubuntu-manual>
>> Post to     : ubuntu-manual@xxxxxxxxxxxxxxxxxxx
>> Unsubscribe : https://launchpad.net/~ubuntu-manual<https://launchpad.net/%7Eubuntu-manual>
>> More help   : https://help.launchpad.net/ListHelp
>>
>
>
> _______________________________________________
> Mailing list: https://launchpad.net/~ubuntu-manual
> Post to     : ubuntu-manual@xxxxxxxxxxxxxxxxxxx
> Unsubscribe : https://launchpad.net/~ubuntu-manual
> More help   : https://help.launchpad.net/ListHelp
>
>

References