mozilla
Your Search Results

    Documentation plans

    The MDN community sometimes is tasked with large documentation projects—that is, large amounts of documentation to be written or edited about a specific topic, or a large maintenance project to existing content. In order to be properly prepared to work on these projects, we first create a documentation plan which outlines:

    • What the project is
    • Why the project needs to be done
    • How urgent the project is
    • What needs to be done to achieve the desired result
    • User stories: examples of use cases for the project's output
    • Prerequisites or requirements
    • Who will work on the project
    • Any notes with implementation suggestions and ideas.

    These plans are used through the process of planning and scheduling the work on the project, as well as to help prioritize the project as compared to other proposed projects.

    Note: It's important to keep in mind that these documentation project plans are proposals. Not all of them will be done at all, and there's no guarantee as to when those that are done will begin.

    Once a project has been accepted, assigned to writers, and begun, the plan document is used to generate a doc status page for the project, and research and writing begins.

    To learn more about ongoing documentation projects, see the doc status overview.

    Plans

    Here's a list of the current documentation project plans.

    Developer phone guide documentation plan
    The aim of this project is to scope out, collect and publish all information about the various Mozilla-sponsored Firefox OS developer phones, in an easy to navigate format.
    Gaia web components and design patterns documentation plan
    This project will document Web components, as well as a full set of design patterns for Gaia that need to be documented. These new docs need to go in the App Center Design section.
    Game developer zone documentation plan
    This is the documentation plan for our project to produce a top-notch game development resource for Web apps and Web sites.
    Learning area documentation plan
    The Learning Area project on MDN will address this gap by creating a new "zone" for beginners (and those expanding their current skills). The goal of the project is to create a curriculum for learning web development, with great content, examples, and ways to test your knowledge.
    QA documentation plan
    Mozilla has lots of QA documentation available: QMO, Main MDN QA landing page, Firefox OS automated testing landing page, and more. We ought to streamline our QA content by weeding out the obsolete stuff, updating the out of date stuff, and turning the different resources into a more cohesive resource.
    RecRoom documentation plan
    RecRoom is the codename of a new MDN area that will provide resources for beginning Web app developers, as well as overall best practices guides for app development.
    Remove in-content iframes
    Each of the documents listed below has at least one in-place use of the <iframe> element within it. In order to improve performance and allow us to more easily revise and correct layout in the future, we need to quickly update all of these pages to use macros instead.  This is somewhat urgent, as there is work that needs to be done by our development team that cannot begin until all of these are fixed. That's where you come in!
    Service Workers documentation plan
    We will need full documentation of Shared Workers, including references, a guide to its use, and examples that demonstrate both how to use it and why you might choose to use it. This article presents a plan for this doc project.
    Update HTML element interface documentation
    This project will involve updating these documents, finishing them, and then adding new information, such as documented lists of the events that can be fired by each element.
    Web Workers documentation plan
    There are multiple kinds of Worker designed for different tasks, and we only document some of them. In addition, much of our existing material is dated, and sample code no longer works. We need to update the existing content and add new material as well.
    WebGL documentation plan
    This project's goal is to produce quality documentation for WebGL, including both a general reference and appropriate and useful how-to guides and tutorials, with code samples.
    WebRTC documentation plan
    The WebRTC documentation project's goal is to produce complete, accurate, and useful documentation and sample code for using the WebRTC API and its related technologies.
    Writing chrome code documentation plan
    We need a good guide to writing chrome JavaScript code. This plan proposes a project to produce that documentation.
    XPCOM documentation plan
    This project's goal is to clean up the existing XPCOM material as much as possible, add and update onboarding content and introductory guides, and so forth. Full documentation of all of XPCOM is no longer a staff writing team priority, due to time constraints.
    picture element documentation plan
    <picture> is a very powerful feature, and this documentation project will produce content explaining its use and will update existing articles on MDN to reference it as appropriate.

    Document Tags and Contributors

    Contributors to this page: Sheppy, DavidWalsh, armukul, Naren
    Last updated by: Sheppy,
    Hide Sidebar