[docs-discuss] Relevancy of the Style Guide

[Paul Kasper]

After reading through this thread, I see two main themes:

1) The style guide is important, but the size is pretty daunting.

2) We need to better set the expectations for the style guide.

I think providing a corresponding "Content Guide" to help address #1 as Brendan mentioned could help, and it may prove useful to split up the 270 pages into more manageable, stand-alone topics.

For #2, we should add more information on the style guide index page to help set expectations about the style guide.  This is done somewhat in the guide's preface, but some of the responses in this thread could be used to help provide better context to new users.

http://www.opensolaris.org/os/community/documentation/doc_collab/style_guide/

Paul
 
 
This message posted from opensolaris.org