Hi all, Great discussion and feedback! Thanks for all of this commentary, keep it coming. I've updated the PDF version of the style guide here for further review: http://opensolaris.org/os/community/documentation/files
The HTML is not ready yet, so it can serve as a baseline for this set of changes. Here's what I fixed, added, and changed: -New book title: "Documentation Style Guide for OpenSolaris". Stephen, I agree that we need a short set of guidelines that describe how to use the term OpenSolaris in documentation that may or may not be in support of the various projects within the code base and might be published elsewhere. I don't have a draft of this content yet, but in the spirit of your request, I've changed the style guide title to reflect fair-use of the term. I hope to have the legal guidelines chapter hammered out by early Feb. -Updated Acknowledgements section on page 17 to reflect new contributors. Wahoo! Much appreciated! -Broken links, no progress here, I'll fix these all at once in a later update. -Ineffective page breaks, fixed on pages 84 and 101, and by sheer luck, the 160/161 page break is also fixed in this version. Rainer, already up to page 160?!! You rock. Also, for those who want to know, 'AI' is acronym-speak at Sun for an action item, or takeaway, something for your To Do list that you'll be tested on later ;) -New Chapter 6: 'Writing Conceptual Descriptions' on page 125. I've tried to distill Brendan's excellent ideas for a new chapter here, please review the outline I've put together and pile on. Any and all contributions of text/content are welcomed. Brendan, I removed the 'list reference info; websites, books' item you sent in your original posting because it just didn't fit with all the rest. But, I think it is important, so let's revisit it again later. Coming Soon: -Legal Guidelines -Writing for a DTD Coming Later: -Separate tutorial/slide show for getting started on docs for OpenSolaris quickly -Separate style top ten for editing your new doc for OpenSolaris quickly Regards, Michelle This message posted from opensolaris.org
