User:jenzed

  • Revision slug: User:jenzed
  • Revision title: User:jenzed
  • Revision id: 125910
  • Created:
  • Creator: jenzed
  • Is current revision? No
  • Comment 310 words removed

Revision Content

temp_image_jen.jpgI'm Jennifer Zickerman. I am working on the Thunderbird documentation, auditing and organizing the existing stuff, identifying gaps and finding people to help fill them. Please contact me with your ideas and suggestions.

(Trivia: In Canada, the letter "Z" is pronounced "zed". Therefore I am "jen" + "zed")

Improvements to add-on docs for Thunderbird 3 release

Problems with "Building a Thunderbird Extension" tutorial

Preliminary planning notes

Planning

Improvements to add-on docs for Thunderbird 3 release

Objective

We need to provide better documentation so that people can write add-ons for Thunderbird. Currently, there are documents in many locations, of questionable relevance and accuracy. With this project, we will create a document set on http://developer.mozilla.org that will be the primary reference. The document structure will be organized; existing docs will be audited, updated and edited; new docs will be created to show developers how to do common tasks. (Caveat: we will prioritize a small list of common tasks and do these, and possibly create a call-to-action / template that contributors can use to add additional "how to" docs.)

Deadlines

April 16: finish plan (this document); submit for feedback from internal folks
April 17/18: incorporate feedback; submit for feedback from community
...others TBD...
... final by TB 3.0 release ...

Approach

  1. (jen) Review existing docs
  2. (jen) Propose better structure / deployment
  3. (jen / MoMo / community) Identify gaps; prioritize
  4. (jen / MoMo / community) Technically validate existing articles
  5. (jen / MoMo / community) Write new articles to fill prioritized gaps
  6. (jen / MoMo / community) Update existing articles
  7. (jen) Implement structure / deployment plan
  8. (jen) Edit the whole shebang
  9. (jen) Add comments / notices to articles that talk about TB extensions on Mozillazine, various blogs, PlanetMoz, etc, pointing to the updated docs on MDC
  10. (jen) Wag tail

Questions

  • What are the high-level intentions regarding developer.mozilla.org versus www.mozilla.org versus wiki.mozilla.org? Are the following statements correct:
    • www.mozilla.org is gradually being retired as a developer documentation site and things are being gradually ported to developer.mozilla.org?
    • www.mozilla.org will be the user documentation site?
    • wiki.mozilla.org is the project management site - there probably shouldn't be any documentation here, just links?
    • It seems that www.mozilla.org is used for "core" docs (instructions for build, localization, etc). Is this as desired?

developer.mozilla.org

Main Page (https://developer.mozilla.org/en/)

Trivia:

  • change "Extensions" page to "Extensions / Add-ons"? (to standardize terminology) (Or is this not really a problem?)
  • standardize on "addons" or "add-ons"? (I know, I know...) (already in style guide?)
  • Why is "Documentation" heading a site tag?
Main Page | Extensions (https://developer.mozilla.org/en/Extensions)

Reorganize page:

==General==

I think there are enough similarities in extension development for Firefox and Thunderbird that the following documents should be "generic" - that is, a single document should cover the topic for both Firefox and Thunderbird (with application-specific sections as necessary).

  • (review / make generic) Setting up extension development environment
  • (review / make generic) Extension Packaging
  • (review / make generic) Installing extensions ( -> Installing / Uninstalling extensions) (do we have existing uninstalling info?)
  • (review / make generic) Extension Frequently Asked Questions
  • (review / make generic) Submitting an add-on to AMO
  • (review / make generic) Code snippets

==Firefox==

  • Firefox addons developer guide
  • Creating Custom Firefox Extensions with the Mozilla Build System
  • Updating extensions for Firefox 3
  • Updating extensions for Firefox 3.5
  • Building an Extension ( -> Building a Firefox extension)

==Thunderbird==

  • (review / update) Building a Thunderbird extension (developer.mozilla.org/en/Building_a_Thunderbird_extension)
  • (new) Developer resources (STEEL, FUEL, GLODA)
  • (new) How to muck around with the folder pane
  • (new) How to muck around with the message view
  • (new) How to muck around with the message list
  • (new) How to add a new tab
  • (new) How to add a column

(many potential topics here - Sheppie also has a list at https://developer.mozilla.org/User:Sheppy/Thunderbird_documentation_list under "Thunderbird architecture" - need to prioritize)

==SeaMonkey==

  • Updating extensions for SeaMonkey 2.0

Other

Tidy up our own pages; point to new / reworked stuff.

Contact info

Email: jen at mozillamessaging dot com
IRC: jenzed
Blog: tbd

Revision Source

<p><img alt="temp_image_jen.jpg" class="internal default" src="/@api/deki/files/3424/=temp_image_jen.jpg" style="width: 186px; height: 96px;">I'm Jennifer Zickerman. I am working on the Thunderbird documentation, auditing and organizing the existing stuff, identifying gaps and finding people to help fill them. Please contact me with your ideas and suggestions.</p>
<p>(Trivia: In Canada, the letter "Z" is pronounced "zed". Therefore I am "jen" + "zed")</p>
<p><a class="internal" href="/User:Jenzed/Improvements_to_add-on_docs_for_Thunderbird_3_release" title="User:Jenzed/Improvements to add-on docs for Thunderbird 3 release">Improvements to add-on docs for Thunderbird 3 release</a></p>
<p><a class="internal" href='/User:Jenzed/Problems_with_"Building_a_Thunderbird_Extension"_tutorial' title='User:Jenzed/Problems with "Building a Thunderbird Extension" tutorial'>Problems with "Building a Thunderbird Extension" tutorial</a></p>
<p><a class="internal" href="/User:Jenzed/Preliminary_planning_notes" title="User:Jenzed/Preliminary planning notes">Preliminary planning notes</a></p>
<h2>Planning</h2>
<h3>Improvements to add-on docs for Thunderbird 3 release</h3>
<h4>Objective</h4>
<p>We need to provide better documentation so that people can write add-ons for Thunderbird. Currently, there are documents in many locations, of questionable relevance and accuracy. With this project, we will create a document set on <a class=" external" href="http://developer.mozilla.org" rel="freelink">http://developer.mozilla.org</a> that will be the primary reference. The document structure will be organized; existing docs will be audited, updated and edited; new docs will be created to show developers how to do common tasks. (Caveat: we will prioritize a small list of common tasks and do these, and possibly create a call-to-action / template that contributors can use to add additional "how to" docs.)</p>
<h4>Deadlines</h4>
<p>April 16: finish plan (this document); submit for feedback from internal folks<br>
April 17/18: incorporate feedback; submit for feedback from community<br>
...others TBD...<br>
... final by TB 3.0 release ...</p>
<h4>Approach</h4>
<ol> <li>(jen) Review existing docs</li> <li>(jen) Propose better structure / deployment</li> <li>(jen / MoMo / community) Identify gaps; prioritize</li> <li>(jen / MoMo / community) Technically validate existing articles</li> <li>(jen / MoMo / community) Write new articles to fill prioritized gaps</li> <li>(jen / MoMo / community) Update existing articles</li> <li>(jen) Implement structure / deployment plan</li> <li>(jen) Edit the whole shebang</li> <li>(jen) Add comments / notices to articles that talk about TB extensions on Mozillazine, various blogs, PlanetMoz, etc, pointing to the updated docs on MDC</li> <li>(jen) Wag tail</li>
</ol>
<h4>Questions</h4>
<ul> <li>What are the high-level intentions regarding developer.mozilla.org versus www.mozilla.org versus wiki.mozilla.org? Are the following statements correct: <ul> <li>www.mozilla.org is gradually being retired as a developer documentation site and things are being gradually ported to developer.mozilla.org?</li> <li>www.mozilla.org will be the user documentation site?</li> <li>wiki.mozilla.org is the project management site - there probably shouldn't be any documentation here, just links?</li> <li>It seems that www.mozilla.org is used for "core" docs (instructions for build, localization, etc). Is this as desired?</li> </ul> </li>
</ul>
<h4>developer.mozilla.org</h4>
<h5>Main Page (https://developer.mozilla.org/en/)</h5>
<p>Trivia:</p>
<ul> <li>change "Extensions" page to "Extensions / Add-ons"? (to standardize terminology) (Or is this not really a problem?)</li> <li>standardize on "addons" or "add-ons"? (I know, I know...) (already in style guide?)</li> <li>Why is "Documentation" heading a site tag?</li>
</ul>
<h5>Main Page | Extensions (https://developer.mozilla.org/en/Extensions)</h5>
<p>Reorganize page:<br>
<br>
==General==</p>
<p>I think there are enough similarities in extension development for Firefox and Thunderbird that the following documents should be "generic" - that is, a single document should cover the topic for both Firefox and Thunderbird (with application-specific sections as necessary).</p>
<ul> <li>(review / make generic) Setting up extension development environment</li> <li>(review / make generic) Extension Packaging</li> <li>(review / make generic) Installing extensions ( -&gt; Installing / Uninstalling extensions) (do we have existing uninstalling info?)</li> <li>(review / make generic) Extension Frequently Asked Questions</li> <li>(review / make generic) Submitting an add-on to AMO</li> <li>(review / make generic) Code snippets</li>
</ul>
<p>==Firefox==</p>
<ul> <li>Firefox addons developer guide</li> <li>Creating Custom Firefox Extensions with the Mozilla Build System</li> <li>Updating extensions for Firefox 3</li> <li>Updating extensions for Firefox 3.5</li> <li>Building an Extension ( -&gt; Building a Firefox extension)</li>
</ul>
<p>==Thunderbird==</p>
<ul> <li>(review / update) Building a Thunderbird extension (developer.mozilla.org/en/Building_a_Thunderbird_extension)</li> <li>(new) Developer resources (STEEL, FUEL, GLODA)</li> <li>(new) How to muck around with the folder pane</li> <li>(new) How to muck around with the message view</li> <li>(new) How to muck around with the message list</li> <li>(new) How to add a new tab</li> <li>(new) How to add a column</li>
</ul>
<p>(many potential topics here - Sheppie also has a list at https://developer.mozilla.org/User:Sheppy/Thunderbird_documentation_list under "Thunderbird architecture" - need to prioritize)</p>
<p>==SeaMonkey==</p>
<ul> <li>Updating extensions for SeaMonkey 2.0</li>
</ul>
<h4>Other</h4>
<p>Tidy up our own pages; point to new / reworked stuff.</p>
<ul> <li><a class=" external" href="http://forums.mozillazine.org/viewtopic.php?t=424455&amp;highlight=thunderbird+overlay" rel="freelink">http://forums.mozillazine.org/viewto...erbird+overlay</a></li> <li><a class=" link-https" href="https://wiki.mozilla.org/Thunderbird:Extensions" rel="freelink">https://wiki.mozilla.org/Thunderbird:Extensions</a> (remove "TBD")</li> <li>"Extensions" section on <a class=" external" href="http://www.mozilla.org/projects/thunderbird/specs/extensions.html" rel="freelink">http://www.mozilla.org/projects/thun...xtensions.html</a> - point to developer.mozilla.org/en/Extensions</li> <li> <p><a class=" external" href="http://kb.mozillazine.org" rel="freelink">http://kb.mozillazine.org</a> (various)</p> </li>
</ul>
<h2>Contact info</h2>
<p><strong>Email</strong>: jen at mozillamessaging dot com<br>
<strong>IRC</strong>: jenzed<br>
<strong>Blog</strong>: tbd</p>
Revert to this revision