- From: Nic da Costa <njr.dacosta@gmail.com>
- Date: Thu, 22 Aug 2013 12:56:16 +0200
- To: Jonathan Garbee <jonathan.garbee@gmail.com>
- Cc: WebPlatform Community <public-webplatform@w3.org>
- Message-ID: <CAOujyar4R9e8gnX3naN0dF0zh9uS=aHPSOQ6ba-avFWAwDLGTQ@mail.gmail.com>
My bad, but agree with writing our own and +1 to the github repo, keeping it in one location and allowing others to use it. // Nic On 22 August 2013 12:28, Jonathan Garbee <jonathan.garbee@gmail.com> wrote: > Yes to writing our own. We can use the UK Gov styleguide as a starting > point and expand from there with what is needed. > > I think it would be best to start a GitHub repo for this work, something > like Webplatform/Writing-Styleguide. That way other projects could easily > use it if they wanted to. > > Nic Da costa, this styleguide is for the actual writing of content, not > code styles. There has already been some work going into code style-guides > for the docs. In the end though we should probably just reference other > pre-existing and used style-guides such as Google's [1]. > > > -Garbee > > [1] http://google-styleguide.googlecode.com/svn/trunk/htmlcssguide.xml > > > On Thu, Aug 22, 2013 at 5:21 AM, Nic da Costa <njr.dacosta@gmail.com>wrote: > >> Hey Doug >> >> My two cents worth, I like that idea of adapting an existing one to >> better suite our needs and like you said, thus filling the gap that has >> been left. I also think it would go nicely with the fact that we are >> documenting the web. Not only can you view the properties, but also a style >> guide to help you write cleaner code, etc. >> >> // Nic da Costa >> >> >> >> On 22 August 2013 11:08, Doug Schepers <schepers@w3.org> wrote: >> >>> Hi, folks– >>> >>> We reference the Yahoo! Style Guide as our style guide; at the time we >>> made that decision, the online version of the Yahoo! Style Guide was free. >>> >>> Apparently, sometime in June they took down the online version, and >>> started pointing instead to printed (commercial) versions. >>> >>> We have a few options at this point >>> * continue to point at the Yahoo! Style Guide, which is (for now, >>> anyway) still available on Archive.org [1] >>> * point to a different resource [2], noting that only Yahoo! had >>> comprehensive focus on online writing >>> * adapt an existing one that has an open license and is close enough [3] >>> * write our own >>> * something else >>> >>> Personally, I like the idea of adapting the Gov.uk style guide to our >>> use, giving them attribution of course. >>> >>> >>> Writing our own or adapting one gives us an interesting longer-term >>> opportunity to fill the void that Yahoo! has left, specifically focused >>> perhaps on writing online documentation. But that may be a bit ambitious >>> and meta to consider now. >>> >>> [1] http://web.archive.org/web/**20121014054923/http://** >>> styleguide.yahoo.com/<http://web.archive.org/web/20121014054923/http://styleguide.yahoo.com/> >>> [2] http://www.dailywritingtips.**com/5-online-style-guides/<http://www.dailywritingtips.com/5-online-style-guides/> >>> [3] https://www.gov.uk/**designprinciples/styleguide<https://www.gov.uk/designprinciples/styleguide> >>> >>> Regards- >>> -Doug >>> >>> >> >
Received on Thursday, 22 August 2013 10:56:51 UTC