+1 well put. :) of course, the cheatsheet can reference page numbers from the style guide; so if something had been summarised too much, then the reader could go straight to the full reference.
Brendan On Thu, May 29, 2008 at 09:22:08AM -0700, Alysson Troffer wrote: > My recommendation is that we keep the OpenSolaris style guide as is but > develop a cheatsheet that's 1-5 pages long, per Brendan's suggestion. That > way, we provide guidance for those who just want the basics and for those > who want to give a more concerted effort. I also like Paul's suggestion to > add more information on the style guide page to help set expectations. > > I agree with others that there's no requirement for folks to read and take a > test on the OpenSolaris style guide before contributing to docs. > > But I agree with Richard that consistency in style helps. In my mind, there's > no question about that. And, of course, technical accuracy is paramount. If > the content isn't technically accurate, the customer isn't going to care how > consistent the style is. > > Alysson > > > This message posted from opensolaris.org > _______________________________________________ > docs-discuss mailing list > docs-discuss at opensolaris.org -- Brendan [CA, USA]
