Project

General

Profile

Task #2394

Updated by Florian Effenberger about 5 years ago

GOALS 

 * Bring all help content together 
 * -Use the XHP help as the primary source of information- 
 * -Make it easier for end users to contribute fixes and new content- 
 * -Retire old tools like the HelpAuthoring extension (buggy and generates bad XHP)- 

 STEPS 

 * -Remove offline (F1 key) built-in help tool in LO 6.0 (Kendy is working on a patch for this)- 

 * -For LO 6.0, create help packages (Olivier)- 

 * -From LO 6.0 onwards, offline and online help will be displayed in the user's browser, for better rendering- 

 * -Update XHP spec for additional sections, so that some can be used in online help, and others for books (Mike and Olivier)- 

 * For LO 6.1, implement an "Edit" button in the online help, along with login credentials and a user-friendly WYSIWYG editor that saves as XHP (Mike to work on this) 

 * Then implement the workflow: use Git as ultimate source of XHP, and Gerrit for submissions of help content changes. When the user saves his/her changes, the editor creates a commit after submission, which goes to Gerrit for review by the docs team. (Maybe add a bot to do XML verification before integration?) (Mike to work on this) 

 * Long-term goal for LO 6.2: extend XHP for merging with the books (eg sections or markup) - maybe even generate new guidebooks from that content. Add an editor preview mode - eg show how changes will look in the context of other help sections or a book 

 * Another long-term goal: add "Search Ask" bar to online help interface 

 * SEO 
 ** avoid double questions on Ask 
 ** categorize, indexes 
 *** current reference isn't usable -> re-tag, re-format 
 *** SEO not everything: is stuff online, should it be? tagging answers on AskBot, everything needs to be searchable and has proper metadata 
 *** Google is main entry point 
 *** "How do I do dots?" -> bullet list 
 ** entry pages 
 ** possibly linking from OOoForum

Back