alt RefactorComments

One of the proposed ZopeWikiPolicies.

ZopeWiki is more useful as a body of clear documentation than a discussion archive. So refactoring and deleting comments is often the right thing to do. This means extracting the useful meat from the comments, integrating it within the main body of the page, and deleting the old comments. When to do this is a judgement call. BeBold. Do refactor the comments of others.

Comment with care. Every comment you add provides some (variable - hopefully positive!) value to the wiki, especially in the short term. But, it also incurs a long-term debt for clarity and maintainability. Don't keep adding comments without occasionally doing some integration, especially of your own.

Pages ending in "...Discussion" are exempt from this. In general, if you hope to preserve your comment for the ages, it should be on a Discussion page such as ZopeWikiDiscussion.

See WikiWikiWeb:DocumentMode vs WikiWikiWeb:ThreadMode for more on this.


In mozilla/firefox, add this bookmark with a keyword like '??' for fast zopewiki searches: *

page rating: 0 from 0 votes

click to rate (voting as: