Hi-- I have finished incorporating the changes into Chapter 1 of the OpenSolaris style guide. If you have the time and the inclination, please review the changes, which are marked with change tracking. Any feedback is welcome. To access the chapter, go to:
http://opensolaris.org/os/community/documentation/reviews/ I'd appreciate receiving your feedback by December 22. I know the holiday season is upon us, and many people are way too busy. If this deadline doesn't work for you, let me know. We could extend it into January, if need be. We don't have a strict deadline for completing this update, but I would like to have some forward motion. I'll summarize the changes here. If you would like to know more about why a specific change was made, feel free to ask. I'd be happy to provide details. The updated chapter includes: * New guidelines * Clarification of existing guidelines * More examples * Bug fixes and consistency improvements Some of the specific changes include the following: * Changed the chapter title to better reflect the chapter contents * Clarified guidelines for using or not using parallel construction in headings at the same level * Clarified guidelines related to using a sentence fragment or a noun phrase as a list introduction * Clarified guidelines about using the bold lead-in list format * Clarified table introduction guidelines * Clarified guideline about not using sentence fragments in table column headings * Added guideline for breaking up long code lines * Removed guidelines about boxing or not boxing code examples (because the use of boxes typically depends on the writing tool) * Clarified guidelines for documenting error messages * Added new examples of illustration types * Removed three illustration types (online graphics, composites, and 2-D action sequences) because they are mostly covered by other illustration types * Refined the index Thanks so much for your help! Alysson -- Alysson Troffer Technical Editor Sun Microsystems, Inc. This message posted from opensolaris.org
