[mb-style] [Clean up CSG] Documentation

Brian Schweitzer brian.brianschweitzer at gmail.com
Wed Feb 13 06:20:28 UTC 2008


So I can start getting the new CSG documentation in order, so as to
prepare for the eventual RFP, would everyone please take a look at the
rewritten CSG I mentioned earlier,
http://wiki.musicbrainz.org/BrianFreud/sandbox , *ignoring* content
for the moment, only paying attention to the structure and style of
the document?

Brendon suggested, rather than continue to use the [part] style within
structural examples that we currently use on the real CSG page, that
we instead use colors.  See
http://wiki.musicbrainz.org/BogdanButnaru/sandbox?highlight=%28sandbox%29
for examples.  If there's feeling that this would be better, I can
convert to using that style on the
http://wiki.musicbrainz.org/BrianFreud/sandbox page.  If we could
decide on this particular point by this weekend, this weekend I can do
that conversion, if needed.  (Also, if we do use colors, opinions on
which two colors are easiest to both read and identify as being
separate colors against a white background?)

Apart from that, is there anything else anyone thinks should be
changed?  Is there something missing from the structure? (not the text
- there's still text that needs to be written, mostly where
indicated.)

Also please look at it from the point of view of "If you, in an edit
note, needed to indicate some specific part of the document to help
identify why you did something or how someone else ought to do
something per CSG, is the structure (5-II-b-example 3) sufficient, or
are there areas that could use further indexing?

Then, *totally apart* from any discussion of the structure or style,
in the content that is already there, is there anything there that
needs further discussion?  (If so, please make a new thread on it, so
we can keep this thread undistracted from structure and style issues).
 I've kept the punctuation guidance to as it is now, but it can be
changed pending our discussions.

There's still a handful of things from the various CSGD/etc
notes/comments/discussions still to be discussed, and still things
we've not yet resolved, but having the structure and style of the
rewritten document established will let me get it finished faster,
rather than waiting until everything has been discussed and decided to
start writing it.

Brian



More information about the Musicbrainz-style mailing list