User: cj Date: 05/12/23 06:41:40 Added: /specs/www/collaterals/process/ Entry-Checklist-Specification-Process.html, Rules-for-Writing-OpenOffice.org-Specifications.html
Log: File Changes: Directory: /specs/www/collaterals/process/ ========================================== File [added]: Entry-Checklist-Specification-Process.html Url: http://specs.openoffice.org/source/browse/specs/www/collaterals/process/Entry-Checklist-Specification-Process.html?rev=1.1&content-type=text/vnd.viewcvs-markup Added lines: 177 ---------------- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> <html> <head> <meta http-equiv="CONTENT-TYPE" content="text/html; charset=windows-1252"> <title>Entry Checklist Software Specification Process</title> <meta name="GENERATOR" content="StarOffice 8 (Win32)"> <meta name="AUTHOR" content="Nikolai Pretzell"> <meta name="CREATED" content="20030901;16015500"> <meta name="CHANGEDBY" content="Christian Jansen"> <meta name="CHANGED" content="20051216;11302000"> </head> <body> <h1 class="western" style="text-align: left;">Entry Checklist Software Specification Process</h1> <table style="width: 100%;" border="1" bordercolor="#000000" cellpadding="4" cellspacing="0"> <col width="205"> <col width="206"> <col width="205"> <thead> <tr valign="top"> <th width="205"> <p class="western" style="font-style: normal;" align="left">Owner:<br> Joerg Sievers</p> </th> <th width="206"> <p class="western" style="font-style: normal;" align="left">Last Change:<br> December 22, 2005</p> </th> <th width="205"> <p class="western" style="font-style: normal;" align="left">Status:<br> Standard</p> </th> </tr> </thead> <tbody> <tr> <td colspan="3" style="vertical-align: top;"> <p class="western" align="left">Goal of this document:<br> Help to check if all necessary pre-requisites for starting the specification process are fulfilled avoiding wasting resources and failures in the specification process.</p> </td> </tr> <tr> <td colspan="3" valign="top"> <p class="western" align="left">Intended readership:<br> Specification authors, specification reviewers (User Experience, Development -, Quality Assurance -<br> and Documentation department)</p> </td> </tr> <tr> <th colspan="3" valign="top"> <p class="western" align="left">Send Feedback to:<br> <a href="mailto:[EMAIL PROTECTED]">[EMAIL PROTECTED]</a></p> </th> </tr> </tbody> </table> <p class="western" align="left">Each of the following check points [C] should be answered with 'Yes'.<span style="font-weight: bold;"></span></p> <h2 class="western" align="left">C1 [Concept]:</h2> <p class="western">Is an approved product concept available, which is understandable for the intended readership?</p> <h2 class="western" style="margin-bottom: 0cm;">C2 [Requirement]:</h2> <p class="western">Does the product concept link to the product requirement(s)?</p> <h2 class="western" style="margin-bottom: 0cm;">C3 [Project-Resource]:</h2> <p class="western">Does exist an approved and assigned project- and resource-plan?</p> <h2 class="western" style="margin-bottom: 0cm;" align="justify">C4 [Agreement]:</h2> <p class="western">Do all assigned project member agree on the project plan and the iTeam composition?</p> <h3 class="western" style="margin-bottom: 0cm; font-style: normal;">Document History</h3> <table style="width: 100%;" border="1" bordercolor="#000000" cellpadding="4" cellspacing="0"> <col width="52"> <col width="383"> <col width="53"> <col width="121"> <thead> <tr valign="top"> <th width="52"> <p class="western">Revision</p> </th> <th width="657"> <p class="western">Change</p> </th> <th width="46"> <p class="western">Initials</p> </th> <th width="121"> <p class="western">Date</p> </th> </tr> </thead> <tbody> <tr valign="top"> <td width="52"> <p class="western" align="center">1</p> </td> <td width="657"> <p class="western" align="left">Ownership changed to JSI; Goal statement changed</p> </td> <td width="46"> <p class="western" align="left">JSI</p> </td> <td width="121"> <p class="western" align="left">Sep 22, 2005</p> </td> </tr> <tr valign="top"> <td width="52"> <p class="western" align="center">2</p> </td> <td style="width: 383px;" width="657"> <p class="western" align="left">Result from the inspection review into the document;<br> C5 removed; Visioning now matches to CMS and new format</p> </td> <td width="46"> <p class="western" align="left">JSI</p> </td> <td width="121"> <p class="western" align="left">Sep 23, 2005</p> </td> </tr> <tr valign="top"> <td width="52"> <p class="western" align="center">3</p> </td> <td width="657"> <p class="western" align="left">Header changed, Status changed for approving document.</p> </td> <td width="46"> <p class="western" align="left">JSI</p> </td> <td width="121"> <p class="western" align="left">Oct 10, 2005</p> </td> </tr> <tr valign="top"> <td width="52"> <p class="western" align="center">4</p> </td> <td width="657"> <p class="western" align="left">C1 sentence corrected with better wording.</p> </td> <td width="46"> <p class="western" align="left">JSI</p> </td> <td width="121"> <p class="western" align="left">Oct 12, 2005</p> </td> </tr> <tr valign="top"> <td width="52"> <p class="western" align="center">5</p> </td> <td width="657"> <p class="western" align="left">Rules revised for OpenOffice.org usage</p> </td> <td width="46"> <p class="western" align="left">CJ</p> </td> <td width="121"> <p class="western" align="left">Dec 16, 2005</p> </td> </tr> <tr valign="top"> <td width="52"> <div align="center"> 6</div> </td> <td width="657">Converted to HTML</td> <td width="46">CJ</td> <td width="121">Dec 22, 2005</td> </tr> </tbody> </table> </body> </html> File [added]: Rules-for-Writing-OpenOffice.org-Specifications.html Url: http://specs.openoffice.org/source/browse/specs/www/collaterals/process/Rules-for-Writing-OpenOffice.org-Specifications.html?rev=1.1&content-type=text/vnd.viewcvs-markup Added lines: 346 ---------------- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> <html> <head> <meta http-equiv="CONTENT-TYPE" content="text/html; charset=windows-1252"> <title></title> <meta name="GENERATOR" content="StarOffice 8 (Win32)"> <meta name="AUTHOR" content="Christian Jansen"> <meta name="CREATED" content="20051012;16182200"> <meta name="CHANGEDBY" content="Tino Rachui"> <meta name="CHANGED" content="20051024;20261800"> <meta name="SDFOOTNOTE" content=";;;;P"> <meta name="SDENDNOTE" content="ARABIC"> </head> <body dir="ltr" lang="en-US" text="#000000"> <div align="left"> <h1>Rules for Writing Software Specifications</h1> </div> <table border="1" bordercolor="#000000" cellpadding="4" cellspacing="0" width="100%"> <col width="205"> <col width="206"> <col width="205"> <thead> <tr valign="top"> <th width="205"> <p style="font-style: normal;" align="left">Owner:<br> Christian Jansen</p> </th> <th width="206"> <p style="font-style: normal;" align="left">Last Change:<br> December 22, 2005</p> </th> <th width="205"> <p style="font-style: normal;" align="left">Status:<br> Preliminary</p> </th> </tr> </thead> <tbody> <tr> <td colspan="3" valign="top" width="636"> <p align="left"><b>Goal of this document:<br> </b> This rule set assists specification authors creating specifications. It captures the essential specification rules that have to be followed.</p> </td> </tr> <tr> <td colspan="3" valign="top" width="636"> <p align="left"><b>Intended readership:<br> </b> Specification authors, specification reviewers (Development -, Quality Assurance -and Documentation department)</p> </td> </tr> <tr> <th colspan="3" valign="top" width="636"><p align="left">Send Feedback to:<br> <a href="mailto:[EMAIL PROTECTED]">[EMAIL PROTECTED]<br> </a></p> </th> </tr> </tbody> </table> <p align="left">Each of the following rules [R] is accompanied by a couple of checklist questions. The optimum is to answer all of the questions with 'Yes'.</p> <h2 align="left">R1 [COMPLETE]:</h2> <p align="left">First and foremost a specification has to be complete. That means all relevant aspects of a feature have to be captured.</p> <p align="left">When user interfaces (UI) are involved: </p> <ul> <li>Are the topics of the <a href="../guides/Accessibility-checklist.html"><img src="../guides/images/Rules-for-Writing-OpenOffice.org-Specifications_html_d4e38e3.gif" name="Grafik1" align="bottom" border="0" height="14" width="16">Accessibility Checklist</a> covered?<li>Are the topics of the <a href="../guides/I18n_in_Software.html"><img src="../guides/images/Rules-for-Writing-OpenOffice.org-Specifications_html_d4e38e3.gif" name="graphics1" align="bottom" border="0" height="14" width="16">Globalization Checklist</a> covered?<li>Are the topics of the <img src="../guides/images/Rules-for-Writing-OpenOffice.org-Specifications_html_d4e38e3.gif" name="graphics2" align="bottom" border="0" height="14" width="16"><a href="../guides/_components.inv/UITextStyleGuide.html#Checklist">OpenOffice.org Interface Text Style Guide</a> checklist covered?<li>Do alerts meet the requirements specified in the <a href="../guides/Alert-Guidelines.html"><img src="../guides/images/Rules-for-Writing-OpenOffice.org-Specifications_html_d4e38e3.gif" name="graphics3" align="bottom" border="0" height="14" width="16"> Alert Guidelines</a>?<li>Are all Menu related changes specified in the <a href="http://specs.openoffice.org/appwide/menus/MenuStructure.sxw";><img src="../guides/images/Rules-for-Writing-OpenOffice.org-Specifications_html_d4e38e3.gif" name="graphics4" align="bottom" border="0" height="14" width="16"> Comprehensive OpenOffice.org Menu</a> Specification? <li>Are all toolbar related changes specified in the <a href="http://specs.openoffice.org/appwide/toolbars/Toolbar_content_spec.sxw";><img src="../guides/images/Rules-for-Writing-OpenOffice.org-Specifications_html_d4e38e3.gif" name="graphics5" align="bottom" border="0" height="14" width="16"> Comprehensive OpenOffice.org Toolbar</a> Specification? <li>Is each UI element specified in detail (e.g default values, input and output ranges, interactions and possible relations to other UI elements and parts of the UI)? <li>Is the exception handling specified in detail? </ul> <h2 align="left">R2 [CLEAR]:</h2> <ul> <li>Each statement has to be unambiguously clear to Development -, Quality Assurance -and Documentation department <li> <li>Is the specification in it self clear enough to the intended readership for being implemented, being tested and for being documented?<br> <li>Are you using quantifiable statements instead of interpretable generalities? <li>Have you avoided to use terms like more, most, less, easy, improve, enhanced, better? <li>Are you consistent within the specification in it self, and to specifications which relate to the feature you are specifying? </ul> <h2 align="left">R3 [SIMPLE]:</h2> <ul> <li>Each statement shall be as short and simple as possible. </ul> <p align="left">Is any secondary writing regarding the detailed specification clearly separated e.g. “comments”, “notes”, “suggestions”, “ideas”, “reasons”?</p> <h3 align="left">Document History:</h3> <table border="1" bordercolor="#000000" cellpadding="4" cellspacing="0" width="100%"> <col width="54"> <col width="383"> <col width="51"> <col width="121"> <thead> <tr valign="top"> <td width="54"> <div align="center"> <p>Revision</p> </div> </td> <td width="594"> <p>Change</p> </td> <td width="51"> <p>Initials</p> </td> <td width="121"> <p>Date</p> </td> </tr> </thead> <tbody> <tr valign="top"> <td width="54"> <div align="center"> <p>1</p> </div> </td> <td width="594"> <p>First draft created</p> </td> <td width="51"> <p>CJ/TRA</p> </td> <td width="121"> <p>June 8, 2005</p> </td> </tr> <tr valign="top"> <td width="54"> <div align="center"> <p>2</p> </div> </td> <td width="594"> <p>Reviewed by Jörg Sievers</p> </td> <td width="51"> <p>JSI</p> </td> <td width="121"> <p>June 8, 2005</p> </td> </tr> <tr valign="top"> <td width="54"> <div align="center"> <p>3</p> </div> </td> <td width="594"> <p>Based on feedback rules revised</p> </td> <td width="51"> <p>CJ/TRA</p> </td> <td width="121"> <p>June 9, 2005</p> </td> </tr> <tr valign="top"> <td width="54"> <div align="center"> <p>4</p> </div> </td> <td width="594"> <p>Merged rules and checklist questions</p> </td> <td width="51"> <p>CJ/TRA</p> </td> <td width="121"> <p>July 18, 2005</p> </td> </tr> <tr valign="top"> <td width="54"> <div align="center"> <p>5</p> </div> </td> <td width="594"> <p>Based on inspection rules & header revised</p> </td> <td width="51"> <p>CJ</p> </td> <td width="121"> <p>September 30, 2005</p> </td> </tr> <tr valign="top"> <td width="54"> <div align="center"> <p>6</p> </div> </td> <td width="594"> <p>Header revised</p> </td> <td width="51"> <p>CJ</p> </td> <td width="121"> <p>October 10, 2005</p> </td> </tr> <tr valign="top"> <td width="54"> <div align="center"> <p>7</p> </div> </td> <td width="594"> <p>R1 revised,R3 revised, Links added</p> </td> <td width="51"> <p>CJ</p> </td> <td width="121"> <p>October 19, 2005</p> </td> </tr> <tr valign="top"> <td width="54"> <div align="center"> <p>8</p> </div> </td> <td width="594"> <p>Made doc OpenOffice.org compliant</p> </td> <td width="51"> <p>CJ</p> </td> <td width="121"> <p>December 22, 2005</p> </td> </tr> </tbody> </table> </body> </html> --------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
