Edgewall Software

Version 2 (modified by Christian Boos, 14 years ago) ( diff )

copy review discussion from TracDev/ToDo@75

TracGuide for 0.12

This part of the wiki is dedicated to the preparation of the TracGuide for the 0.12 release.

Pages currently specific to 0.12:

Review Guidelines

  • mark.m.mcmahon: Would you suggest the following:
    • Review the diff for each page that was copied (spelling, grammar, technical)
    • Review the page as a whole, formatting, etc
      • cboos: Indeed, that would be my preferred way. Spelling and grammar fixes should be done straight ahead, no need to discuss them of course, the same for formatting fixes I suppose. Suggestions for documentation changes, additions or clarifications (or simplifications!) could be done in a variety of ways, just be creative! For example:
        • add a === Discussion section at the bottom, with your remarks or additions
        • add #!div in place with some distinctive style, e.g. 
          {{{#!div style="background:#efe"
Addition: / Rewrite:  / ... 
}}}

          Addition: / Rewrite: / …

        • in place italics may not stand out distinctive enough from the original documentation, you could use [[span(style=background:#efe, Also mention...)]] Also mention…
        • … or much simpler, none of the above, just boldly change the documentation if you think you can make an improvement (we'll notice the change and review the differences anyway)
    • does it make sense to log a bitesize, documentation bug for each doc review task?
      • cboos: I don't think so, I think it'll be more effective to collaborate on the document in place
  • rblank: I would suggest starting with the pages under 0.12, proofread whole pages (spelling, grammar, consistency, obsolete text) and fix things as you go along. You may want to open a single "Documentation review" ticket to document your progress for others potential reviewers (and get attribution!).
Note: See TracWiki for help on using the wiki.