Jump to: navigation, search

Difference between revisions of "Development Resources/FAQs/About Review Documentation"

(New page: The "docuware" for a Review has traditionally been a slide deck however there is no reason to use slides: a short report/document would work equally well if not better (reports are informa...)
 
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
The "docuware" for a Review has traditionally been a slide deck however there is no reason to use slides: a short report/document would work equally well if not better (reports are information dense relative to slides, and that's a good attribute).
+
The documentation for a [[Development Resources/HOWTO/Review Information for Project Leads | Review]] has traditionally been a slide deck however there is no reason to use slides: a short report/document would work equally well if not better (reports are information dense relative to slides, and that's a good attribute).
  
 
<span style="margin-right:6px; margin-top:5px; float:left; color:ivory; background:#FF9999;  
 
<span style="margin-right:6px; margin-top:5px; float:left; color:ivory; background:#FF9999;  
Line 5: Line 5:
 
padding-left:2px; padding-right:2px; font-family:times; ">R</span><br>In any case, the docuware must be/have:
 
padding-left:2px; padding-right:2px; font-family:times; ">R</span><br>In any case, the docuware must be/have:
  
* '''Neutral File Format.''' The docuware must be published in an operating-system neutral file format. PPT and DOC files are not considered neutral. PDF is currently the best choice and thus we require docuware to be published in PDF. The EMO can convert Open Office and Microsoft Office to PDF if you are unable to do so.
+
* '''Neutral File Format.''' The docuware must be published in an operating-system neutral file format. PPT and DOC files are not considered neutral. HTML or PDF are currently the best choices. The EMO can convert Open Office and Microsoft Office to PDF if you are unable to do so.
* '''Archival Quality.''' The docuware must be comprehensible and complete on its own without requiring explanation by a human presenter. Archival quality is required because the docuware will be available on the eclipse.org website in perpetuity; future Eclipse users, adopters, and even new project committers will consult it long after the review conference call has been completed.
+
* '''Archival Quality.''' The docuware must be comprehensible and complete on its own without requiring explanation by a human presenter. Archival quality is required because the document will be available on the eclipse.org website in perpetuity; future Eclipse users, adopters, and even new project committers will consult it long after the review conference call has been completed.
* '''Correct Copyright and License.''' The docuware is being written (and thus copyrighted) by you, not by the Eclipse Foundation, and thus the copyright statement needs to be by you (or your employer). Similarly, the content should be licenses under the EPL.
+
* '''Correct Copyright and License.''' The document is being written (and thus copyrighted) by you, not by the Eclipse Foundation, and thus the copyright statement needs to be by you (or your employer). Similarly, the content should be licenses under the EPL.
* '''Usable for a Phone Conversation.''' Remembering that most conversations about the docuware will be done over voice, email, IM, or other electronic media - not in a face-to-face situation - the docuware must have page and/or paragraph numbers so that the two parties in conversation can easily refer to the same section or slide.
+
  
''This page is moderated by Anne Jacko and Bjorn Freeman-Benson (Eclipse Foundation)''
+
''This page is moderated by the EMO''
 
[[Category:Development_Resources]]
 
[[Category:Development_Resources]]
 
[[Category:How to Contribute]]
 
[[Category:How to Contribute]]

Latest revision as of 12:29, 24 August 2010

The documentation for a Review has traditionally been a slide deck however there is no reason to use slides: a short report/document would work equally well if not better (reports are information dense relative to slides, and that's a good attribute).

R
In any case, the docuware must be/have:

  • Neutral File Format. The docuware must be published in an operating-system neutral file format. PPT and DOC files are not considered neutral. HTML or PDF are currently the best choices. The EMO can convert Open Office and Microsoft Office to PDF if you are unable to do so.
  • Archival Quality. The docuware must be comprehensible and complete on its own without requiring explanation by a human presenter. Archival quality is required because the document will be available on the eclipse.org website in perpetuity; future Eclipse users, adopters, and even new project committers will consult it long after the review conference call has been completed.
  • Correct Copyright and License. The document is being written (and thus copyrighted) by you, not by the Eclipse Foundation, and thus the copyright statement needs to be by you (or your employer). Similarly, the content should be licenses under the EPL.

This page is moderated by the EMO