Download Reference Manual
The Developer's Library for D
About Wiki Forums Source Search Contact

Changes between Version 14 and Version 15 of DocChangeManage

Show
Ignore:
Author:
kris (IP: 68.122.43.222)
Timestamp:
07/06/06 08:34:49 (11 years ago)
Comment:

Next edit! We're got a whole new trend going here ;)

Legend:

Unmodified
Added
Removed
Modified
  • DocChangeManage

    v14 v15  
    99The goal is to make sure that changes are at least loosely regulated and audited.  Many people have opinions on what needs to go into a document, what needs to be changed, and what needs to removed.  It is a little presumptuous to assume consensus will reign in a documentation effort so large.  Here we encourage some form of accountability and prior discussion before one chooses to modify a document in any significant way. 
    1010 
    11 That said, there are some levels of modification that really require no discussion at all: things like grammar and spelling errors are often easily fixed as the previewer happens to run across them.  Any level of bureauocracy that slows fixing those errors down is counter-productive.  Still, if there be any question about sentence structure or documentation accuracy, by all means bring the issue up with one of the principal documenters, the original documenter, project reviewers, or the project leader.  Clearly, this effort will account for large volumes of text.  There will be lots of errors both in grammar and technical accuracy.  There is no doubt that we will benefit from many people proofreading the contributions. But the benefit is lost if the majority of these proofreaders change the documents arbitrarily. 
     11That said, there are some levels of modification that really require no discussion at all: things like grammar and spelling errors are often easily fixed as the previewer happens to run across them.  Any level of bureauocracy that slows fixing those errors down is counter-productive.  Still, should there be any question about sentence structure or documentation accuracy, by all means bring the issue up with one of the principal documenters, the original documenter, project reviewers, or the project leader.  Clearly, this effort will account for large volumes of text.  There will be lots of errors both in grammar and technical accuracy.  There is no doubt that we will benefit from many people proofreading the contributions. But the benefit is lost if the majority of these proofreaders change the documents arbitrarily. 
    1212 
    1313For now, the project leader is to be capable of arbitrary decision for document changes, additions, or removals.  This decision is one of expediance, primarily for the sake of maintaining project momentum.  The project lead also will arbitrate and make conclusions on matters where no concensus has been reached among contributors.  Still the project lead should maintain a level of consideration by maintaining contact with the writers before proceeding with significant changes.  This is a request, not a requirement.  Likewise, prior to implementing changes, project organizers, principal documenters, and reviewers are encouraged to liaise with the project lead to decide on issues of wiki document presentation.