110 likes | 230 Views
Guidelines for reviewing IEEE P1603 document covering clarity, content, completeness, consistency, practicality, organization, style. Provide feedback on each criteria. Email feedback to alf@eda.org, mention version, page, line numbers.
E N D
IEEE P1603 reviewer’s guideline Wolfgang Roethig, WG chair
Please review the IEEE P1603 document for the following criteria • Clarity • Contents • Completeness • Consistency • Practicality • Organization • Style
Clarity • Is the contents understandable? • Does the section/subsection describe what the title says? • If not, should the title be changed or the section/subsection be rewritten? • Feel free to ask questions for clarification • Don’t assume that someone else (with more expertise on the subject?) will understand if you don’t
Contents • Does the proposed contents fulfill a purpose? • Is the proposed contents acceptable? • If not, please state the reasons and draft alternative proposal – be brief
Completeness • Is a section complete in itself? • Are appropriate references given to other sections/subsections or to external documents? • If information is missing, is it found in other sections/subsections? – please identify • Feel free to draft a proposal that fills the blanks
Consistency • Are there any contradictions within a section/subsection? • Are there any contradictions between sections/subsections? • Propose resolutions for apparent contradictions
Practicality • Is the proposed contents practical for new implementations? • Is the proposed contents compatible with existing implementations? • Are changes with respect to previous versions justified? • Give practical examples, if there are issues
Organization • Are the topics presented in an appropriate order? • Do the topics of a section/subsection belong together? • Are topics that belong together found in the same section/subsection? • Feel free to propose an alternative organization
Style • Simplicity: any suggestions to shorten a 300 page document are welcome • Tables and figures are as important as text • Check for correct and concise terminology • No need to report typos and grammar in detail: this is the responsibility of the technical editor
How to give feedback • Email to alf@eda.org is best • Break it into several emails if subject is long • Please refer to version, page and line numbers • Direct editing of source text by reviewer should be exception, not rule
Thanks for your time and effort to review the IEEE P1603 document