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