Documents Repository Mapping

• Design/Development Documents

• Purpose:
  This is where all design and developing documents live. Developers or API users of Lexical Tools should find detail information of how Lexical Tools ^Java were developed from this page.
• Location:
  It is posted at $LVG_DIR/docs/designDoc/index.html
• Update Frequency:
  Design documents are updated daily to keep all information valid.
• Directory list:
  • ../../apiDoc@ -> $LVG_DIR/docs/apiDoc
  • ../../dsignDoc
  • ../../examples@ -> $LVG_DIR/examples
  • ../../sources@ -> $LVG_DIR/sources
  • ../../userDoc

  UDFs:

  • bitMask
  • canonize
  • cvs
  • database
  • dev
  • doc
  • flow
  • gui
  • metaphone
  • syntax
  • token
  • trie
  • unicode
  • webtool

    Life Cycle phases:

  • requirement
  • design
  • implement
  • test
  • deploy
  • maintain

    Presentations:

  • Interim Report
  • Norm Brief

• API Documents

• Purpose:
  This document is generated by javadoc program. It provides all details information for lvg Api specifications. It is a reference document for users who use lvg Api. In most cases, users should only pay attention to classes under Api and Flows packages.
• Location:
  This document is located under $LVG_DIR/docs/apiDoc
• Update Frequency:
  Should be updated only there is a new release.
• Directory list:
  See release CD at $LVG_DIR/docs/apiDoc.

• Users Documents/Guide

• Purpose:
  This document serves as the official release documents for Lexical Tools. It is the user guide for Lexical Tools.
• Location:
  It is posted at $LVG_DIR/docs/userDoc
• Update Frequency:
  Should be updated when there is a new release (yearly).
• Directory list:
  • ../apiDoc@ -> $LVG_DIR/docs/apiDoc
  • ../designDoc
  • ../userDoc

• Lvg Web Site

• Purpose:
  This web site provides all updated information for Lexical Tools.
• Location:
  It is posted at Lvg Home
• Update Frequency:
  Should be updated daily for those issues are not release related.
• Directory list:
  • docs/
    • apiDoc/ ...
    • designDoc/ ...
    • examples/ ...
    • sources/ ...
    • userDoc/ ...
  • image/ ...
  • release/ ...
  • web/
    • about.html
    • contact.html
    • download.html
    • faq.html
    • home.html
    • menu.html
    • release
      • index.html
      • 2002.html
      • 2003.html
      • 2004.html
      • 2005.html

• Documents Mapping Design