Thread Links Date Links
Thread Prev Thread Next Thread Index Date Prev Date Next Date Index

[8023-POEP] Suggested rules for making comments on D3.2



With another comment period upon us, I wanted to remind the group how to make it easier (and thus, faster) to import and proofread the comments.
 
 
1. Do use the comment tool.  Do not make lots of text or email comments.  Text and email comments are a manual input process and subject to human error.  A way to guarantee accurate commenting is to use comment tool.
 
2. The subclause field HAS TO include the clause number.  Example:  clause: 33 Subclause: 33.1.4.  This is for parsing out of comments to associate editors and to ensure comments sort in order with the text.
 
3. When commenting on Annex include annex letter with clause. Example Commenting on Annex 33C section 1.4: Clause: 33C Subclause: 33C.1.4
 
4. When commenting on tables or figures, put clause and subclause where located then start comment with name of Table or Figure.  This makes comment flow logically in the sort so the comment is handled while the group is in that section.
 
5. do not use tildes '~' in your comments.  Causes import tool to barf.
 
6. Rename filename after generating comments with the comment tool.  Append your name to front of filename to make it distinctive. 
 
7. Do not use periods in your filename other than the one before .csv; also causes import tool to barf.
 
 
 
Chad's general rules to make comments easier to read (thus easier to resolve):
 
DO copy the text you are commenting against and paste into the comment.  This helps immensely if you have a typo in the page or line number
 
DO cover only one topic per comment.  File multiple comments for multiple concepts in the same page/line.
 
DO NOT make a comment and leave the suggested remedy empty.  If you know it is a problem, you have an idea of the answer.  Share this with the group.
 
DO make crisp comments, minimize 'stream of consciousness' style of writing.  Present the facts and the solution.
 
Thanks and see you all in Dallas.
 
-Chad