Documentation Future

489 views
452 views

Published on

The future of documentation

Published in: Technology
0 Comments
0 Likes
Statistics
Notes
  • Be the first to comment

  • Be the first to like this

No Downloads
Views
Total views
489
On SlideShare
0
From Embeds
0
Number of Embeds
2
Actions
Shares
0
Downloads
3
Comments
0
Likes
0
Embeds 0
No embeds

No notes for slide

Documentation Future

  1. 1. The ways to get documentation in the future OpenOffice.org Content Developer 10:00 AM 2009-11-05
  2. 2. Who am I <ul><li>Working for a social insurance organization
  3. 3. Project member since autumn 2002
  4. 4. Content Developer
  5. 5. 2003 to 2006 de-contact documentation
  6. 6. Current projects: de, documentation, extension-website, OpenOffice.org Portable, OOoAuthors.org </li></ul>
  7. 7. Agenda <ul><li>Current status
  8. 8. Known issues
  9. 9. Possible solutions for known issues
  10. 10. Structure in the future
  11. 11. Workflow </li></ul>
  12. 12. Current status CVS Docs & Files Wiki OOoAuthors
  13. 13. Current status: CVS <ul><li>Working: only (Content)Developer
  14. 14. High boarded hurdle: ssh-key / know how
  15. 15. Colaboration: only between Developers
  16. 16. Check-in for other contributing people: risk for the developer </li></ul>
  17. 17. Current status: Docs & Files <ul><li>Create folder: only (Content)Developer
  18. 18. Boarded hurdle
  19. 19. No versioning
  20. 20. Structure can be confusing
  21. 21. Performance
  22. 22. Long path to document
  23. 23. No workflow </li></ul>
  24. 24. Current status: Wiki <ul><li>Low border: </li><ul><ul><li>Account for every one
  25. 25. Edit rights for every one </li></ul></ul><li>Boarded hurdle: </li><ul><ul><li>Specific markup language
  26. 26. Edit by hand in many cases </li></ul></ul><li>No workflow
  27. 27. No review process
  28. 28. Different licenses </li></ul>
  29. 29. Current status: OOoAuthors <ul><li>Low border: </li><ul><ul><li>account for every one
  30. 30. Author rights: question on the list
  31. 31. Work on documents: no specific language (OooWriter) </li></ul></ul><li>Workflow included / customizable
  32. 32. Scalable
  33. 33. License inside the document
  34. 34. Offline editing </li></ul>
  35. 35. Known issues <ul><li>OpenOffice.org changes often </li><ul><li>Documentation / howto not up to date </li></ul><li>Lack of personal resources
  36. 36. Different licenses </li><ul><li>Issue with copying material
  37. 37. PDL: record every change
  38. 38. CC: record every change: not explicit </li></ul></ul>
  39. 39. Possible Solutions
  40. 40. Often changes of OOo <ul><li>Up-to-date first steps documentation
  41. 41. Complete handbooks in short chapters </li><ul><li>Priority: usage of program modules (i.e. Writer, Calc …) </li></ul><li>Single howtos for new features
  42. 42. Linked together with cross-references </li></ul>
  43. 43. New Personal resources <ul><li>Short guide to work
  44. 44. Easy and short work for beginners </li><ul><li>quick success </li></ul><li>Clear structure of editing / reviewing </li><ul><li>workflow </li></ul><li>“Coach” for beginners </li></ul>
  45. 45. Licenses: Wiki <ul><li>License change: </li><ul><li>If CC -> PDL: </li><ul><li>New version of CC and upgrade </li></ul><li>If PDL -> CC: </li><ul><li>New version of PDL and upgrade (license update posible?) </li></ul><li>Content with no license: -> delete </li></ul><li>New clean instance with one license or dual-license (triple-license) </li></ul>
  46. 46. Licenses: OOoAuthors <ul><li>Dual License: </li><ul><li>CC + GPL </li></ul><li>Translation: third license possible (PDL)
  47. 47. No issue with transfer into wiki or cvs
  48. 48. But backwards from cvs or PDL-wiki
  49. 49. Future: triple license? </li></ul>
  50. 50. Structure in the future
  51. 51. Structure in the future No double effort (no copying) Wiki <ul><li>Developer Docs/ Howtos
  52. 52. Quick changing content </li></ul>OOoAuthors <ul><li>Quality proofed Documentation (reviewed) (handbooks, howtos for user) </li></ul>CVS <ul><li>Publishing final content in PDF (source: *.odt (project resources) </li></ul>
  53. 53. Current Workflow Submit Reject Publish Publish Publish Publish Internal draft Review Publish external Publish internal Private
  54. 54. Planed Workflow Submit Reject Publish Publish Publish Publish Internal draft First Review Publish external Publish internal Private Final Review
  55. 55. Questions?
  56. 56. Thanks!

×