DCgov / dc-madison

The Madison platform allows public collaboration on draft documents such as legislation and policies! This codebase is a project of the OpenGov Foundation, the OCTO Technology Innovation Program and DC Council.
http://drafts.dc.gov
GNU General Public License v3.0
3 stars 1 forks source link

Usage of 'activity' unclear for 'active legislation', document updating concerns #62

Open emanuelfeld opened 8 years ago

emanuelfeld commented 8 years ago

Difference between 'Recent Activity' (I assume that means actual changes to the document) and 'Most Active Documents' (i.e. comments and annotations).

Are documents actually being updated? What happens to the edits/annotations on previous versions? Is there the ability to tie together multiple versions?

emanuelfeld commented 8 years ago

Relatedly, this makes it sound like the statistics were updated 2 days ago:

image

krusynth commented 8 years ago

To answer the original issue here, Most active means the most comments & annotations, Recent activity refers to most recently updated documents (we can change this to Recently Updated), and Updated under stats refers to the document itself (we can add clarity by changing the text to Document last updated X days ago).

With regard to documents being updated:

The original intent of Madison is to allow user-submitted comments to shape the legislation, so yes documents are able to be edited. In carrying out this goal, the new editor we're working on will allow admins to incorporate suggested changes directly to the documents. Right now, however, edits simply replace the content of the currently in-place document - which is somewhat dangerous from a data standpoint.

This introduces the problem you've suggested however - comments and annotations on previous versions of a document may no longer apply. Moreover, from a technical standpoint, it is very hard to anchor annotations to a document that has changed in any way. The solution we'd discussed internally was, If a document has an older version, show a list of older versions, and the original comments and annotations are preserved on that version. We would ideally like to keep annotations attached to content that has not changed, but again that's technically difficult at this time.

There are lots of ways to solve this problem, to be fair, and we can brainstorm on that more, but for the time being we have at least an idea of a good enough solution that we can always improve on later - we're not losing any data along the way.

emanuelfeld commented 8 years ago

Those language fixes work for me. I was thinking similarly re: keeping a list of document versions (with ability to click to see older ones with annotations still there). Difficulty with versioning and keeping annotations, is that there are annotations for only parts of lines and sometimes people highlight the whole line even if they only are commenting on a section. Hard to automatically determine if a document update addressed a concern.

krusynth commented 8 years ago

Difficulty with versioning and keeping annotations, is that there are annotations for only parts of lines and sometimes people highlight the whole line even if they only are commenting on a section. Hard to automatically determine if a document update addressed a concern.

Absolutely. The best we could do here realistically is to let users know that a thing they left an annotation on has changed in some way, and that their annotation has been archived along with the previous version, giving them the opportunity to re-comment.