musings on document reviews

Bijan writes:
> > Well, I've done some reviewing of the XML Syntax document. I wanted  
> > to remind reviewers that you can inline comments using the review  
> > template e.g.,:
> >
> > 	{{Review|~~~~|I'd make the prior paragraph a temporary editors  
> > note. It shouldn't appear in the final spec.}}
> >
> > (the ~~~~ gets auto expanded with your name and a timestamp, a la:
> > 	{{Review|[[User:BijanParsia|BijanParsia]] 08:31, 14 March 2008  
> > (EDT)|I'd make the prior paragraph a temporary editors note. It  
> > shouldn't appear in the final spec.}}
> > )

Indeed.

Also, I wonder, with some of your comments, like

   "I don't think "easily implemented" is the right description. The key
   isn't easy of implementation (KRSS would probably be better there),
   but fit with modern XML technology and practices."

if it wouldn't be better to just change the text, and have the "review
comment" be your change comment.  I'm not really suggesting you should
have done that out of the blue, but it's the wiki ethos, and if we as a
WG could adopt it, I think it would be helpful.

> > One thing that would be nice is if I could generate a text file of  
> > my review comments (with back pointers) so that I could email them  
> > to the list with more "overally" comments....

The wealth of possible tools here is enormous.  :-/    They get more
interesting if you consider getting 5000 public comments on a draft, 75
of which correct the same typo.    Fortunately (perhaps), OWL probably
isn't nearly that interesting to the public.  Some groups have attempted
to develop solutions.

My favorite technology for a solution would be a database (perhaps
decentralized via RDF, but whatever) of classified annotations on the
document, with both traditional interfaces (query/report generation),
and an interface that used ajax to allow people to show & edit the
annotations in-place in the document.

What you want should be pretty easy to do with XML tools, especially if
we change Template:Review to add more invisible XML structure to the
generated document.

      -- Sandro

Received on Tuesday, 18 March 2008 12:11:26 UTC