4.0 Documentation Plan
From OpenLaszlo
- The Developer's Guide, Deployer's Guide, Designer's Guide, Reference Manual and Components Guide will be reviewed for platform-specific information.
- Platform specific content will be flagged, in the source for the documentation, with a <runtime value=""/> tag in order to allow graphically calling attention to the text and, possibly, conditional compilation of documentation for different runtimes.
- new features, such as support for CSS, Audio, Video, "mixins", etc will be thoroughly documented.
- The introductory sections of the Developer's Guide will be completely rewritten to explain new architecture, language features (such and the new class model), developing for different target runtimes, etc.
- The introductory material in Laszlo in 10 Minutes and the Laszlo Explorer will be revamped with a focus on the special features of 4.0
- Many content bugs currently logged against the existing documentation will be resolved.
- The doctools will be rewritten to accommodate the new class models, and, perhaps, to facilitate a move towards more standard open-source documentation model (e.g. cocoon, etc)
- The file system structure source will be normalized or at least cleared up. As part of this, if time permits, information in the components guide will be normalized into Developer Guide format.
- Documentaion tools and processes will be explained on the OpenLaszlo Wiki to allow members of the community to contribute to the effort.
