<html>
<head>
<base href="https://wiki.asterisk.org/wiki">
<link rel="stylesheet" href="/wiki/s/en/2176/25/9/_/styles/combined.css?spaceKey=AST&forWysiwyg=true" type="text/css">
</head>
<body style="background: white;" bgcolor="white" class="email-body">
<div id="pageContent">
<div id="notificationFormat">
<div class="wiki-content">
<div class="email">
<h2><a href="https://wiki.asterisk.org/wiki/display/AST/Project+Planning+Template">Project Planning Template</a></h2>
<h4>Page <b>added</b> by <a href="https://wiki.asterisk.org/wiki/display/~mjordan">Matt Jordan</a>
</h4>
<br/>
<div class="notificationGreySide">
<div class='panelMacro'><table class='warningMacro'><colgroup><col width='24'><col></colgroup><tr><td valign='top'><img src="/wiki/images/icons/emoticons/forbidden.gif" width="16" height="16" align="absmiddle" alt="" border="0"></td><td>This page is currently a draft proposal of a design template for Asterisk projects.</td></tr></table></div>
<h1><a name="ProjectPlanningTemplate-Description"></a>Description</h1>
<p>Each major project being performed for a targeted release of Asterisk should have a project page on the Asterisk wiki. The purpose of a project page is to provide a point of reference for the project for Asterisk contributors.</p>
<p>Please use this page as a template for your projects under the <a href="/wiki/display/AST/Roadmap" title="Roadmap">Roadmap</a> Section.</p>
<h1><a name="ProjectPlanningTemplate-ProjectOverview"></a>Project Overview</h1>
<p>This section should provide a description of the project and its goals. Appropriate information here would include:</p>
<ul>
<li>Motivations behind the project</li>
<li>The end product of the project, e.g., a new channel driver, resource module, or some functionality</li>
</ul>
<h1><a name="ProjectPlanningTemplate-RequirementsandSpecification"></a>Requirements and Specification</h1>
<p>This section can take several forms depending on the project, but should serve the same purpose regardless: define the minimum requirements of the project. This should include the minimum feature set that the project <b>must</b> provide to be considered complete. Appropriate ways of conveying this information can include User Stories or Use Cases.</p>
<p>This section should also provide details about the project from an end-user perspective. This can include dialplan configuration, sample configuration files, API descriptions, etc.</p>
<p>If needed, break this section up until multiple subsections. Subpages are appropriate for reference information (such as configuration schemas, detailed API descriptions, etc.)</p>
<h1><a name="ProjectPlanningTemplate-Design"></a>Design</h1>
<p>For sufficiently complex projects, a high level design may be needed to illustrate how the project plugs into the overall Asterisk architecture. Sufficiently detailed design of the project should be provided that provides newcomers to the Asterisk project with some concept as to how the code is constructed.</p>
<p>Design should be independent of the implementation, i.e., if the code is not drastically changed, it should not require updates to this section.</p>
<h1><a name="ProjectPlanningTemplate-Planning"></a>Planning</h1>
<p>Provide links to the appropriate JIRA issues tracking work done, in progress, and yet to be started. Identify the primary points of contact for the project for collaborators to contact. If appropriate, meeting times/notes can be linked to from here.</p>
<h1><a name="ProjectPlanningTemplate-ReferenceInformation"></a>Reference Information</h1>
<p>Include links to code reviews, asterisk-dev mailing list discussions, and any other related information.</p>
</div>
<div id="commentsSection" class="wiki-content pageSection">
<div style="float: right;" class="grey">
<a href="https://wiki.asterisk.org/wiki/users/removespacenotification.action?spaceKey=AST">Stop watching space</a>
<span style="padding: 0px 5px;">|</span>
<a href="https://wiki.asterisk.org/wiki/users/editmyemailsettings.action">Change email notification preferences</a>
</div>
<a href="https://wiki.asterisk.org/wiki/display/AST/Project+Planning+Template">View Online</a>
|
<a href="https://wiki.asterisk.org/wiki/display/AST/Project+Planning+Template?showComments=true&showCommentArea=true#addcomment">Add Comment</a>
</div>
</div>
</div>
</div>
</div>
</body>
</html>