On Tue, Dec 04, 2012 at 07:41:06PM +0530, Radhika Puthiyetath wrote: > Hello Community, > > Any thoughts on the need of a style guide for the CloudStack Documentation ?
Any project of sufficient size probably needs at least a rudimentary style guide. > First of all, do we need one-If yes, do we need to > create afresh , or follow the existing style guides > within Apache projects, such as Maven. Here is the link: > http://maven.apache.org/guides/development/guide-documentation-style.html. The Maven guide doesn't seem to be very complete. I don't think we need to write a massive guide for the project, just keep a page on the wiki for specific style issues related to ACS. This might be a good question for the Publican list - whether there's a recommended guide for other projects using Publican. I know that Sun's "Read Me First!" is well-liked by a lot of technical writers - but I don't know that it's available online and I'm not sure if we want to suggest a guide people would need to purchase. > Please educate me on the Apache way for Documentation style. AFAIK this is a per-project thing, not something that's common to all ASF projects. > Alternatively, we can always follow what XenServer documentation is following. Which is? :-) > PS: I do understand that enhancing the documentation/ fixing the doc defect > is the first priority of the doc contributors. Indeed - but as we go through docs and generate new docs or edit old ones, it's nice to have a standard to adhere to. -- Joe Brockmeier http://dissociatedpress.net/ Twitter: @jzb
