Documents Repository Overview

• Design/Development Documents

• Purpose:
  This is where all design and developing documents live. Developers or API users of CSpell should find detail information of how CSpell ^Java were developed from this document.
• Location:
  It is posted at ${CSPELL_DIR}/docs/designDoc/index.html

• API Documents

• Purpose:
  This document is generated by javadoc program. It provides all details information for CSpell API specifications. It is a reference document for users who use CSpell API.
• Location:
  This document is located under ${CSPELL_DIR}/docs/apiDoc

• Users Documents/Guide

• Purpose:
  This document serves as the official release documents for CSpell. It is the user guides for using CSpell.
• Location:
  It is posted at ${CSPELL_DIR}/docs/userDoc

• CSpell Web Site

• Purpose:
  This web site provides all updated information for CSpell.
• Location:
  It is posted at CSpell Home