Finding and Using Flex Documentation

Matt Chotin posted similar information to Flexcoders last week, and it reminded me that many people don’t know about the Flex Documentation page. The Flex Documentation page contains links to the latest and greatest Flex docs in PDF and LiveDocs format. It also contains a link to a ZIP file that contains the complete documentation for local use.

Now that we have that out of the way, let’s look at the complete range of formats and locations:

  • The Flex Builder Help system contains all Flex documentation in HTML format. Each page contains a link to the same page running on LiveDocs. We leverage the Eclipse Help engine for table of contents, search, and dynamic help functionality.
  • LiveDocs contains all Flex documentation in HTML, along with comments from community and Flex-team members. We occasionally update pages on LiveDocs and use the LiveDocs Related Topics functionality to provide links to related pages, such as Flex Quick Starts. We leverage google search and provide a JavaScript-based table of contents.
  • Release Notes provide a high-level description of each product, along with a list of known issues and, for an update release like Flex 2.0.1, fixed bugs.
  • The Installation page provides install instructions for Flex Builder, Flex Data Services, Flex SDK, and Flex Charting.

The one you use depends on the way you work. If you use Flex Builder, the Flex Builder Help system is a handy and fast tool that links to LiveDocs for the latest and greatest information. Tip: Have you tried Flex Builder Dynamic Help? Dynamic Help, which is an option on the Help menu) provides links to the current tag and changes the links in near real time as you move through your file.

If you’re not using Flex Builder, try LiveDocs. You can either display the home page and navigate using the table of contents or use a search engine to hone in on the right page. Also, if you’re offline for a significant portion of your development time, we suggest downloading the complete doc set (50Mb ZIP file) and using it locally.