Revision 647153 of Documentation plans

  • Revision slug: MDN/Plans
  • Revision title: Documentation plans
  • Revision id: 647153
  • Created:
  • Creator: Sheppy
  • Is current revision? No
  • Comment

Revision Content

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.

Plans

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

{{LandingPageListSubpages}}

Revision Source

<p>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:</p>
<div class="twocolumns">
 <ul>
  <li>What the project is</li>
  <li>Why the project needs to be done</li>
  <li>How urgent the project is</li>
  <li>What needs to be done to achieve the desired result</li>
  <li>User stories: examples of use cases for the project's output</li>
  <li>Prerequisites or requirements</li>
  <li>Who will work on the project</li>
  <li>Any notes with implementation suggestions and ideas.</li>
 </ul>
</div>
<p>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.</p>
<div class="note">
 <p><strong>Note:</strong> It's important to keep in mind that these documentation project plans are <strong>proposals</strong>. Not all of them will be done at all, and there's no guarantee as to when those that are done will begin.</p>
</div>
<p>Once a project has been accepted, assigned to writers, and begun, the plan document is used to generate a <a href="/en-US/docs/MDN/Doc_status">doc status page</a> for the project, and research and writing begins.</p>
<h2 id="Plans">Plans</h2>
<p>Here's a list of the current documentation project plans.</p>
<p>{{LandingPageListSubpages}}</p>
Revert to this revision