Documenting OOo


Published on

Documenting suite

Published in: Technology
  • Be the first to comment

  • Be the first to like this

No Downloads
Total views
On SlideShare
From Embeds
Number of Embeds
Embeds 0
No embeds

No notes for slide
  • Notes: The app help Other projects (eg translations, Twitter account) What's missing/where do we need help What can we do in the next 12 months to improve things – to make all doc jobs easier, and make doc contrib interesting Is the Wiki doing the job? Communication? Is the mailing list active/doing it's job? Other methods of communication? Twitter? A dedicated IRC channel? Other ways? Are there other ways we can encourage community participation? Remember to keep the entry point as low as possible/reasonable so people are not put off by a complex doc process requiring special software/skills. Missing manuals? How can new authors get started? Publication channels? Doc project roles?
  • Documenting OOo

    1. 1. OOo.doc 2009 Documenting Clayton Cornell Documentation Project co-lead 09:00 - 09:45 5 November 2009
    2. 2. Agenda <ul><li>OOo Doc Objectives and Goals
    3. 3. OOoAuthors
    4. 4. Status of the Doc Project
    5. 5. Documenting OOo in 2010
    6. 6. Challenges
    7. 7. Questions </li></ul>
    8. 8. OOo Doc Objectives and Goals <ul><li>Provide easy user access and easy user contribution
    9. 9. Make sure we have targeted content
    10. 10. Make sure the documentation is up-to-date and technically accurate
    11. 11. Be efficient , and minimize duplication
    12. 12. Use transparent processes
    13. 13. Include all locales </li></ul>
    14. 14. OOoAuthors <ul><li>Jean Hollis Weber </li><ul><li>Co-lead in the OOoDoc Project (early 2009)
    15. 15. Retired technical editor, mainly software
    16. 16. Author of first book published on Writer
    17. 17. Lead editor at OOoAuthors since late 2004
    18. 18. Main work: user guides (odt, pdf, wiki) </li></ul></ul>
    19. 19. Why OOoAuthors? <ul><li>Some people prefer to work in ODT, not wiki
    20. 20. IssueTracker is cumbersome and difficult to use for documentation tracking </li></ul>
    21. 21. Status of the Doc Project <ul><li>Wiki </li><ul><li>~400,000 page views per month </li></ul><li>Forum </li><ul><li>~ 4500 postings per month, ~ 23450 members </li></ul><li>Doc Website </li><ul><li>~ 100,000 monthly page views </li></ul><li>Installed Help </li><ul><li>2300 pages of Help </li></ul></ul>
    22. 22. Status of the Doc Project cont. <ul><li>OOoAuthors team: </li><ul><li>User Guides in ODT & PDF </li></ul><li>UGs put on Wiki, PDFs on Docs website
    23. 23. UGs translated into several languages </li><ul><li>Most translations start from English
    24. 24. Some start from other languages </li></ul></ul>
    25. 25. Status of the Doc Project cont. <ul><li>Increase in Wiki edits
    26. 26. New and updated documents </li><ul><li>Conceptual Guide Second Edition
    27. 27. OOo Setup Guide
    28. 28. User Guides
    29. 29. Almost 50,000 words added and changed in Help
    30. 30. Translations of several guides from English into German, Chinese, Italian, Japanese and French </li></ul></ul>
    31. 31. Documenting OOo in 2010 <ul><li>Continue to build the relationship between the OOoDoc Project and OOoAuthors </li></ul>
    32. 32. Documenting OOo in 2010 cont. <ul><li>Wiki </li><ul><li>Improve the toolset/extensions </li></ul><li>Define publication channels </li><ul><li>Two mailing lists: </li><ul><li>
    33. 33. [email_address] </li></ul><li>New communication channels </li><ul><li>IRC (new) </li><ul><li> </li></ul><li>Twitter? </li></ul></ul></ul>
    34. 34. Documenting OOo in 2010 cont. <ul><li>Identify gaps in the documentation
    35. 35. Find overlaps in documentation effort
    36. 36. Develop a localization process
    37. 37. Clarify the publication process
    38. 38. Clearly define the project roles
    39. 39. Encourage new contributors/authors/mentors </li></ul>
    40. 40. Challenges <ul><li>Lack of volunteers and mentors </li><ul><li>Main gap: writers who know Calc and Base </li></ul><li>Wiki structure </li><ul><li>Managing updates and synchronizing translations </li></ul><li>Localization </li><ul><li>Various localizations being done, but many incomplete </li></ul></ul>
    41. 41. Challenges cont. <ul><li>Editing </li><ul><li>No formal editing or validation of Wiki input </li><ul><li>We could possibly use FlaggedRevs in the Wiki to control and validate edits on documents </li></ul></ul><li>Publishing </li><ul><li>Document publishing methods are unclear
    42. 42. Publication process is defined but not followed </li></ul></ul>
    43. 43. Questions Questions and Discussion