Happy Friday, if it is still Friday for you :) I'm pleased to announce that the Beta version of the 'Documentation Style Guide for OpenSolaris' is posted here:
http://opensolaris.org/os/community/documentation/files/styleguide.pdf Thanks to everyone who provided feedback and helped with new or changed content for this draft!! Please check to be sure I've made the correct changes, vertical bars in the margins indicate a change, strikethrough indicates deletion, underlining shows the additions. Please send any new review comments to this alias so we can sort them and address them as a group--thanks in advance for your help and input. Here's a summary of the changes I incorporated and things that are still pending: New stuff: -Resources: -Ben's links to DocBook resources -Placeholder for illustration tools -Writing Conceptual Descriptions (placeholder draft) -Identifying your audience -Analyzing user tasks -New bullet to 'always include table column headers' Fixed stuff: -Broken links -Blank Pages -Ineffective Page Breaks -Overprinting (not fixed yet) -Missing Table Column heading -Order of *C and C shell (not fixed because there is no Numbers and Symbols section in this table) Removed stuff: -Sun-specific intructions for cross-references -Use of customer, manager, lead writer, and vendor -Section about phone numbers and warrantees -TBT and WLC in training section (I left the rest because this seciton attempts to distinguish different types of documentation, and in that context, I feel the information is still relevant--but I'm open to removing the whole section if folks say so). Coming soon: Legal and license chapter More tools information and DTD stuff Have a great weekend, Michelle This message posted from opensolaris.org
