Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

For the 1.0 release, we will implement online help using DocBook.  DocBook is an open standard of XML markup that allows you to structure documentation into books or articles.  The 0.8 documentation has been converted to XML and we are now using Oxygen to edit the DocBook books.  We are not expecting functional SMEs to modify the XML within Oxygen but will create the content using Word templates provided below.  As some areas documentation only need needs minor modifications, separate files documents will be created with what has already been some content included.

We plan to continue having the Overviews and Guides available from the wiki for the 1.0 release.  Nora will revise the Overview documents created in 0.8 and request SME teams to review.  The Guides will be converted to PDF from the OLE DocBook books and upload onto the wiki.

Steps for OLE User Guides

Due date:

Nora has created a list of documentation needs in Google Docs: Documentation needs for 1.0

...