Documentation Tracker

Tracking the status of LSR documentation. Especially important at this point

Current Documentation

In addition to this wiki we have the following files available as part of the Source distribution (S) online (L) or installed (I).

• Workbook - architecture for maintainers, rather too detailed for scriptors (SL)
• UI - Screen Reader User Experience as defined by base perks (SL)

• Web UI - User Web experience as defined by FireFox perk (SL)

• man pages - overview and CLI switches (SI)

Needed Documentation and updates

Workbook

This is mostly complete. Add examples to help understanding and show how the bits work together. Simplified UML would be useful.

Perk Scriptors Guide

Missing. How to write perks, LSR conceptual model, architectural view, objects, apis etc. Good practice including patterns and style. Examples, cookbook, UML.

Repurpose, Redesign and Refactoring

Missing. What could/would be done differently or improved with benefit of hind site. Wishlist. Ideas to move LSR forward. New features and use cases. (probably best to split this into requirements/implementation)

Flyer

Flagrant promotion. Why is it so cool, what are the benefits, what are it's strengths. Why use. Why hack on it. The elevator pitch. This is probably the home page.