[docs-discuss] Relevancy of the Style Guide
Alan McClellan
Alan.McClellan at Sun.COM
Thu May 29 09:32:36 PDT 2008
I think this sounds like a great plan. -alan
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
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.opensolaris.org/pipermail/docs-discuss/attachments/20080529/3b34b0e1/attachment.html>
More information about the docs-discuss
mailing list