Last night, I got home after another fun and productive MDN documentation sprint; this one was held in Mozilla’s lovely Vancouver office. In addition to Mozilla’s paid writing staff and a few core contributors, we had Mounir Lamouri, a Mozilla platform engineer, on hand to offer technical expertise about web-based device APIs. In addition, two Vancouver-area residents, Aras and Amr, also joined us, making their first contributions to MDN!
To top it all off, Vancouver-based content strategy expert Rahel Bailie dropped in to help us do a quick-and-dirty content strategy analysis; it was reassuring to discover that we’re more or less thinking along the right lines and on the right track in that regard.
Both virtual and in-person sprints have their pros and cons. Virtual sprints let people participate from anywhere without the need to travel and leave their normal lives and families behind. But in-person sprints give us the opportunity to have the kinds of conversations that work best when everyone’s in the same room together with a whiteboard. We had several of those conversations during this sprint in addition to documentation writing activities.
Some of the whiteboard discussions we had during this sprint included:
- We talked about the content and structure for the home page and global navigation of MDN. Expect to see these changes start to happen in the next few weeks!
- A team met a couple of times to draft and refine a specification for the Localization Dashboard. This has been proposed as a Google Summer of Code project. Whether a student tackles this for GSoC or our own dev team builds it, having a spec is an important step.
- We had a very long and engaging discussion about MDN’s page types and the elements they need. I will be turning our sketches and notes into a specification proposal this week.
- We brainstormed ways to improve our involvement in events, whether they’re MDN doc sprints, other Mozilla events, or even external events.
- We talked about our new process for managing documentation bugs by using the “Developer Documentation” component in Bugzilla along with Scrumbu.gs.
We also had lots of documentation written. I doubt this is an exhaustive list (in fact, I know that it isn’t), but it’s a list of what people specifically noted down that they worked on. Even as an incomplete list, this is a lot of great work. I’d like to thank everyone for their time and effort!
Aras Balali Moghaddam
Aras modified the following pages to make use of live code samples. We’re pretty excited about our live sample system, so getting more of them is always awesome!
- Updated the MathML mspace element’s documentation per bug 717546.
- Updated the methods of inlDOMUtils per bug 839443.
- Updated the documentation for document.createElement() for bugs 851916 and 844127.
- Updated the documentation for table.insertRow() and tableRow.insertCell() for bug 824116.
- Created documentation based on several code bugs marked dev-doc-needed.
- Updated MathML compatibility information on reference pages to note that Chrome has completely removed MathML support.
- Moved MathML pages into the new hierarchy (Web/MathML and Mozilla/MathML_Project).
- Added a section about media presentation to Firefox OS apps tips and techniques.
- Updated the docs for nsINavHistoryService to fix bug 703893.
- Updated the docs for JS_SetGCZeal to note a signature change in Firefox 14, per bug 787723.
- Created the template APIListAlpha for producing alphabetical lists of subpages as pretty indexes.
- Started work on building the hierarchy for the new open Web documentation structure, including the Web landing page and the Web APIs page.