Google Groups no longer supports new Usenet posts or subscriptions. Historical content remains viewable.
Dismiss
Topic drivers for MDN documentation
9 views
Skip to first unread message
Sheppy
Feb 29, 2012, 3:27:19 PM2/29/12
to
A few months ago, we decided to set up a driver system for driving
documentations on a release-by-release basis, with a writer taking
lead on each release as it made its way through the release train
process.
This... didn't really work out. It was a noble experiment that failed.
We're now in the process of switching to a per-topic documentation
driver system. This will let us get documentation for the most
important material done more quickly (at least in theory) regardless
of when it ships. The driver for each topic area will prioritize the
work for that subject matter and help ensure that things get written
when appropriate. They'll help coordinate the writers that are
interested in contributing to that topic and make sure that the docs
in that area of the wiki are kept tidy and are properly crosslinked.
Obviously, the first step in switching to this driver model is to get
people selected for each of the topic areas. We have a new page on the
wiki for this: https://developer.mozilla.org/Project:en/Topic_drivers
If you know of a topic area that's not listed there (or is a large
enough subset of one of the ones already there that it should be
handled separately), please feel free to add it. Similarly, if you're
interested in being a documentation driver for one of those topics,
let me know, or put your name down.
I've not yet selected the topics I will drive, other than likely the
XUL and XPCOM stuff. I'm waiting to see what others would like to do
first (indeed, if anyone else wants those two, feel free to take them
from me). My primary goal as always will be to coordinate the overall
documentation effort, maintain the site in general, and contribute as
needed, in addition to driving whichever topics I wind up with.
If you have questions or would like to volunteer to drive a topic,
feel free to comment here, send me email, or pop into #devmo on
irc.mozilla.org.
Eric Shepherd
Developer Documentation Lead
Mozilla
http://www.bitstampede.com/
documentations on a release-by-release basis, with a writer taking
lead on each release as it made its way through the release train
process.
This... didn't really work out. It was a noble experiment that failed.
We're now in the process of switching to a per-topic documentation
driver system. This will let us get documentation for the most
important material done more quickly (at least in theory) regardless
of when it ships. The driver for each topic area will prioritize the
work for that subject matter and help ensure that things get written
when appropriate. They'll help coordinate the writers that are
interested in contributing to that topic and make sure that the docs
in that area of the wiki are kept tidy and are properly crosslinked.
Obviously, the first step in switching to this driver model is to get
people selected for each of the topic areas. We have a new page on the
wiki for this: https://developer.mozilla.org/Project:en/Topic_drivers
If you know of a topic area that's not listed there (or is a large
enough subset of one of the ones already there that it should be
handled separately), please feel free to add it. Similarly, if you're
interested in being a documentation driver for one of those topics,
let me know, or put your name down.
I've not yet selected the topics I will drive, other than likely the
XUL and XPCOM stuff. I'm waiting to see what others would like to do
first (indeed, if anyone else wants those two, feel free to take them
from me). My primary goal as always will be to coordinate the overall
documentation effort, maintain the site in general, and contribute as
needed, in addition to driving whichever topics I wind up with.
If you have questions or would like to volunteer to drive a topic,
feel free to comment here, send me email, or pop into #devmo on
irc.mozilla.org.
Eric Shepherd
Developer Documentation Lead
Mozilla
http://www.bitstampede.com/
David Bruant
Feb 29, 2012, 3:58:53 PM2/29/12
to Sheppy, dev...@lists.mozilla.org
Le 29/02/2012 21:27, Sheppy a écrit :
> (...)
I've also added a "Twitter column" since by experience, I have been
reached more often by Twitter for doc-related topics.
David
> (...)
>
> Obviously, the first step in switching to this driver model is to get
> people selected for each of the topic areas. We have a new page on the
> wiki for this: https://developer.mozilla.org/Project:en/Topic_drivers
>
> If you know of a topic area that's not listed there (or is a large
> enough subset of one of the ones already there that it should be
> handled separately), please feel free to add it. Similarly, if you're
> interested in being a documentation driver for one of those topics,
> let me know, or put your name down.
I'm picking JavaScript. I've just added my name on the list.
> Obviously, the first step in switching to this driver model is to get
> people selected for each of the topic areas. We have a new page on the
> wiki for this: https://developer.mozilla.org/Project:en/Topic_drivers
>
> If you know of a topic area that's not listed there (or is a large
> enough subset of one of the ones already there that it should be
> handled separately), please feel free to add it. Similarly, if you're
> interested in being a documentation driver for one of those topics,
> let me know, or put your name down.
I've also added a "Twitter column" since by experience, I have been
reached more often by Twitter for doc-related topics.
David
Kang-Hao (Kenny) Lu
Mar 1, 2012, 3:20:43 PM3/1/12
to
(12/03/01 4:27), Sheppy wrote:
> [snip]
IRC if I have editorial questions about articles in that area? That
sounds nice. At least it's probably better than having to ask questions
randomly on IRC and wait for people to respond.
> [snip]
I have the bandwidth to coordinate stuff so I haven't put my name in.
Cheers,
Kenny
> [snip]
> We're now in the process of switching to a per-topic documentation
> driver system. This will let us get documentation for the most
> important material done more quickly (at least in theory) regardless
> of when it ships. The driver for each topic area will prioritize the
> work for that subject matter and help ensure that things get written
> when appropriate. They'll help coordinate the writers that are
> interested in contributing to that topic and make sure that the docs
> in that area of the wiki are kept tidy and are properly crosslinked.
Does this mean that the topic driver will be the person I can ping on
> driver system. This will let us get documentation for the most
> important material done more quickly (at least in theory) regardless
> of when it ships. The driver for each topic area will prioritize the
> work for that subject matter and help ensure that things get written
> when appropriate. They'll help coordinate the writers that are
> interested in contributing to that topic and make sure that the docs
> in that area of the wiki are kept tidy and are properly crosslinked.
IRC if I have editorial questions about articles in that area? That
sounds nice. At least it's probably better than having to ask questions
randomly on IRC and wait for people to respond.
> [snip]
> Similarly, if you're interested in being a documentation driver for one
> of those topics, let me know, or put your name down.
I am myself interested in CSS and DOM although I am not so sure whether
> of those topics, let me know, or put your name down.
I have the bandwidth to coordinate stuff so I haven't put my name in.
Cheers,
Kenny
Sheppy
Mar 1, 2012, 5:17:03 PM3/1/12
to
On Mar 1, 3:20 pm, "Kang-Hao (Kenny) Lu" <kennyl...@csail.mit.edu>
wrote:
full-time writers would also be happy to help still as well.
wrote:
> (12/03/01 4:27), Sheppy wrote:
> > [snip]
> > We're now in the process of switching to a per-topic documentation
> > driver system. This will let us get documentation for the most
> > important material done more quickly (at least in theory) regardless
> > of when it ships. The driver for each topic area will prioritize the
> > work for that subject matter and help ensure that things get written
> > when appropriate. They'll help coordinate the writers that are
> > interested in contributing to that topic and make sure that the docs
> > in that area of the wiki are kept tidy and are properly crosslinked.
>
> Does this mean that the topic driver will be the person I can ping on
> IRC if I have editorial questions about articles in that area? That
> sounds nice. At least it's probably better than having to ask questions
> randomly on IRC and wait for people to respond.
Yes, that would be the case, although certainly I or any of the other
> > [snip]
> > We're now in the process of switching to a per-topic documentation
> > driver system. This will let us get documentation for the most
> > important material done more quickly (at least in theory) regardless
> > of when it ships. The driver for each topic area will prioritize the
> > work for that subject matter and help ensure that things get written
> > when appropriate. They'll help coordinate the writers that are
> > interested in contributing to that topic and make sure that the docs
> > in that area of the wiki are kept tidy and are properly crosslinked.
>
> Does this mean that the topic driver will be the person I can ping on
> IRC if I have editorial questions about articles in that area? That
> sounds nice. At least it's probably better than having to ask questions
> randomly on IRC and wait for people to respond.
full-time writers would also be happy to help still as well.
0 new messages