7 | | - get someone to proof read the new pages. |
8 | | - '''mark.m.mcmahon''': Do you mean the list of all pages under ["0.12/"] in TitleIndex? |
9 | | * '''cboos''': Yes. |
10 | | ''Would you suggest the following:'' |
11 | | - Review the diff for each page that was copied (spelling, grammar, technical) |
12 | | - Review the page as a whole, formatting, etc |
13 | | * '''cboos''': Indeed, that would be my preferred way. |
14 | | Spelling and grammar fixes should be done straight ahead, no need to discuss them |
15 | | of course, the same for formatting fixes I suppose. |
16 | | Suggestions for documentation changes, additions or clarifications (or simplifications!) |
17 | | could be done in a variety of ways, just be creative! For example: |
18 | | * add a `=== Discussion` section at the bottom, with your remarks or additions |
19 | | * add `#!div` in place with some distinctive style, e.g. |
20 | | {{{ |
21 | | {{{#!div style="background:#efe" |
22 | | Addition: / Rewrite: / ... |
23 | | }}} |
24 | | }}} |
25 | | {{{#!div style="background:#efe" |
26 | | Addition: / Rewrite: / ... |
27 | | }}} |
28 | | * in place italics may not stand out distinctive enough from the original documentation, |
29 | | you could use `[[span(style=background:#efe, Also mention...)]]` |
30 | | [[span(style=background:#efe, Also mention...)]] |
31 | | * ... or much simpler, none of the above, just boldly change the documentation |
32 | | if you think you can make an improvement (we'll notice the change and review the |
33 | | differences anyway) |
34 | | - does it make sense to log a bitesize, documentation bug for each doc review task? |
35 | | * '''cboos''': I don't think so, I think it'll be more effective to collaborate |
36 | | on the document in place |
37 | | - '''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!). |
| 7 | - get someone to proof read the new pages, see ["0.12/"] for guidelines |