> Hi all, Hey. :-)
I've had a preliminary look, and have just a few comments so far. All in all, great work. > I've drafted a list of procedures and steps below to > help new and existing community members understand > how to collaborate on documentation for OpenSolaris. > This could be added to the How To Participate page, > or could be separate page or doc. I agree with Eric; keep this on the How To Participate page. That's what this doc is all about. :-) > (and it presumes that a > Review page exists--I think we could use one, what do > you think?) Sounds like a good idea to me. > The purpose of this document is to describe the > instructions for collaborative > documentation development in the OpenSolaris > project. I would tend to agree with Eric on this, but it seems there is sometimes a bit of confusion as to the purpose of a doc despite the intro text. I think a comment to this effect can be used to intro the doc on the How To Participate page, but it won't hurt to include it again as a preface in the doc itself. I do find this text a little awkward, though. Perhaps something simpler, like: "This document describes the processes for collaboration on document development in the OpenSolaris Documentation community." ?? > Write a new document > Request to view a document I suspect you were meaning something specific here (document source?), but it doesn't come across. > Request a change to a document <snip> > Add text to an existing document Could this latter item not be considered as being encompassed by line 3 (quoted before the snip)? > 6-Respond to a documentation change request: Review > bugs that have the > 'opensolaris' keyword and check to see if the > submitter in field 6 answered Yes/No > to the 'Submitter wants to work on bug' field. If > not, proceed to address the change according to > existing processes. If they answered Yes, contact a > doc community leader to get started with working in > the open. Again, a little awkward, I think. It remains a little unclear, though the _gist_ of the text is fairly clear. (Does that make sense?) > 7-Communicate changes and contributions: Post changed > documents to docs-discuss at opensolaris.org and cc: the > bug submitter or contributor with a brief description > of the change and under what heading it appears in > the updated review copy. Feel free to also provide > any addtional review details that might be > appropriate. Except that you can't CC anyone/anything from the forum. You can only CC when submitting from an email client (and since you can only have one email address as yet, those of us contributing from home and work are stuck...). I also worry about the idea of posting a 30-page XML-based document to the discussion forum. This would make for an enormous thread of one post. :-) Perhaps it should involve posting _about_ the change(s), with some way of putting the document on the site (the /tmp folder mentioned elsewhere? the above-mentioned review page?) and a comment to that effect. Then, we would need to move the updated document in place (over the old version) after the review. But, are we overly complicating things, and who would do the work, just which-ever leader gets to it first? Maybe this isn't as difficult as I'm thinking right now. Thoughts? So, those are my preliminary thoughts. If I have any deeper insights, I'll post them. :-) Rainer This message posted from opensolaris.org
