Documentation Review Team

classic Classic list List threaded Threaded
6 messages Options
Reply | Threaded
Open this post in threaded view
|

Documentation Review Team

LordSputnik
So, a lot of people have been noticing that the docs are a bit inconsistent and outdated in places. What's lacking is some sort of review process, so, as I mentioned in the recording title thread, I'd like to do something along the lines of http://tickets.musicbrainz.org/browse/OTHER-155 .

I brought this up in the developer meeting today, and they all seemed happy with some action tacking place.

So, I'd like to start up a small team of people to help review the docs. The rough plan is:

1. Come up with a documentation guideline to be used as the basis for judging everything else (a bit like http://en.wikipedia.org/wiki/Category:Wikipedia_editing_guidelines is, for Wikipedia).
2. Put this through style, to make sure everyone agrees and to pick up areas for improvement.
3. Decide as a team the best way to go about improving the docs themselves. To be honest, at this point there's no clear scope, so once we get to this point, any suggestion that might improve the docs is worth considering.

Please let me know here if you'd like to help!
Reply | Threaded
Open this post in threaded view
|

Re: Documentation Review Team

Alex Mauer
On 08/12/2013 03:16 PM, LordSputnik wrote:
> Please let me know here if you'd like to help!

Love to!


_______________________________________________
MusicBrainz-style mailing list
[hidden email]
http://lists.musicbrainz.org/mailman/listinfo/musicbrainz-style

signature.asc (565 bytes) Download Attachment
Reply | Threaded
Open this post in threaded view
|

Re: Documentation Review Team

tommycrock
In reply to this post by LordSputnik

Happy to, although I think ironing out inconsistencies by rules would be problematic, but it would at least be good to spot them and put them up for discussion!

On Aug 12, 2013 9:37 PM, "LordSputnik" <[hidden email]> wrote:
So, a lot of people have been noticing that the docs are a bit inconsistent
and outdated in places. What's lacking is some sort of review process, so,
as I mentioned in the recording title thread, I'd like to do something along
the lines of http://tickets.musicbrainz.org/browse/OTHER-155 .

I brought this up in the developer meeting today, and they all seemed happy
with some action tacking place.

So, I'd like to start up a small team of people to help review the docs. The
rough plan is:

1. Come up with a documentation guideline to be used as the basis for
judging everything else (a bit like
http://en.wikipedia.org/wiki/Category:Wikipedia_editing_guidelines is, for
Wikipedia).
2. Put this through style, to make sure everyone agrees and to pick up areas
for improvement.
3. Decide as a team the best way to go about improving the docs themselves.
To be honest, at this point there's no clear scope, so once we get to this
point, any suggestion that might improve the docs is worth considering.

Please let me know here if you'd like to help!



--
View this message in context: http://musicbrainz.1054305.n4.nabble.com/Documentation-Review-Team-tp4656711.html
Sent from the MusicBrainz - Style mailing list archive at Nabble.com.

_______________________________________________
MusicBrainz-style mailing list
[hidden email]
http://lists.musicbrainz.org/mailman/listinfo/musicbrainz-style

_______________________________________________
MusicBrainz-style mailing list
[hidden email]
http://lists.musicbrainz.org/mailman/listinfo/musicbrainz-style
Reply | Threaded
Open this post in threaded view
|

Re: Documentation Review Team

CallerNo6
In reply to this post by LordSputnik
On 08/12/2013 01:16 PM, LordSputnik wrote:
> Please let me know here if you'd like to help!
Sounds great. I'm in.

Alex / caller#6

_______________________________________________
MusicBrainz-style mailing list
[hidden email]
http://lists.musicbrainz.org/mailman/listinfo/musicbrainz-style
Reply | Threaded
Open this post in threaded view
|

Re: Documentation Review Team

Frederic Da Vitoria
In reply to this post by LordSputnik
2013/8/12 LordSputnik <[hidden email]>
Please let me know here if you'd like to help!

I don't have much time but if I can lend a hand after I return from my holidays.

--
Frederic Da Vitoria
(davitof)

Membre de l'April - « promouvoir et défendre le logiciel libre » - http://www.april.org

_______________________________________________
MusicBrainz-style mailing list
[hidden email]
http://lists.musicbrainz.org/mailman/listinfo/musicbrainz-style
Reply | Threaded
Open this post in threaded view
|

Re: Documentation Review Team

Ian McEwen
In reply to this post by LordSputnik
On Mon, Aug 12, 2013 at 01:16:55PM -0700, LordSputnik wrote:
>
> Please let me know here if you'd like to help!
>

I like the general idea -- I'd love to be kept in the loop if nothing else so I can be the practicality curmudgeon as usual :)

--
Ian McEwen <[hidden email]> <[hidden email]>
A262 D5C4 40CB 0E1C 5F24 C3A1 ABED 1ABD 7131 A76F
http://ianmcorvidae.net/

_______________________________________________
MusicBrainz-style mailing list
[hidden email]
http://lists.musicbrainz.org/mailman/listinfo/musicbrainz-style

attachment0 (205 bytes) Download Attachment