187046 - (docathon) Mozilla DocAThon web page

Status: RESOLVED INVALID

(Developer Documentation Graveyard :: General, enhancement)

Description

[Brian 'netdragon' Bober]

While talking in #mozilla, we thought it would be good to start the DocAThon
that is similiar in concept to the BugAThon
(http://www.mozilla.org/newlayout/bugathon.html).

This is because documentation is lacking.

I will attach the partially finished page.

Comment 1

[Brian 'netdragon' Bober]

Attachment: DocAThon web page partially done

Comment 2

[John Keiser (jkeiser)]

Well, if you're serious about this, many of the tasks you're talking about have
already been started:

http://moz.zope.org/Members/jkeiser/gecko_doc/document_map is the list of
documentation that needs to be created (there are certainly other tasks but this
is a decent first step)

Other Doc-Related stuff:
http://mozilla.freezope.org/docnotes exists as a place for people to write
little notes and collaborate on documentation, if that helps.
http://moz.zope.org/Members/jkeiser/gecko_doc/api_documentation is a guide for
api documentation in the code.
http://moz.zope.org/Members/jkeiser/gecko_doc/roadmap was our thinking on the
whole documentation thing, there is some decent analysis in there.

I think there's a bug lying around somewhere on the larger effort, but good luck
with this piece of the pie.

Comment 3

[Daniel Wang]

quoted from a n.p.m.documentation post of mine:

  Write Often, Publish Often

  Anyway, I think we can adopt the same philosophy of
  Mozilla developement so to get documentation going.
  We could use a FAQ-centric approach where everyone
  can write a little on whatever and whenever. We could
  just put them in FAQ drafts released regularly to the
  appropriate Mozilla forums. Once an FAQ gains a
  critical, stable mass, it can be broken down into
  differnt documents or published as is to mozilla.org

  This way, anyone can contribute to d11n without
  learning anything special, and no one needs to wait
  for a person with cvs access to really publish
  something. Also, because everyone is so busy, if
  one person becomes to busy to complete something,
  another can pick up immediately.

how about bug 151102?

Comment 4

[Daniel Wang]

Attachment: mozilla-org\html\docs\mdp\docathon.html v1

A new page, modeled after the Bugathon page
<http://www.mozilla.org/newlayout/bugathon.html>
Basically it has intro in Brian Bober's draft and stuff from my n.p.d11n FAQ.
The "So let's write some docs for.. Or we could... Ermmm..." in Brain's version
should go to Doc Roadmap (bug 151101).

Comment 5

[Nickolay_Ponomarev]

With MDC this is pretty much obsolete. Wiki makes it trivial to edit docs and we have lists of things people can help with.