Here are my thoughts on what needs to be done by 1.0 with respect to
technical documentation (not in any particular order). Please comment
on whether or not you agree that these should be requirements for 1.0,
and if you think I've missed anything.
1) Switch to automated API documentation generation
- select method
- update code accordingly
- style them
- publish at an appropriate URL
- incorporate generation into automated build/deploy
2) Tutorials
- ensure there are tutorials for *every* component,
and every part of the Framework
- incorporate working examples directly into the tutorials
3) Overview Documentation
- "Why Fluid?/What is Fluid Infusion?" information
for newcomers
4) Revamped Information Architecture
- in light of API docs moving to a different URL than the wiki,
we should reconsider the organization of all of our techncial
documentation
Some other nice, vaguely documentation-related things, but not sure if
they should be requirements for 1.0 (others, please comment?):
5) Working examples of each component (small and simple),
visible right on the landing page for the component
6) Improved styling of the tutorials
--
Anastasia Cheetham [email protected]
Software Designer, Fluid Project http://fluidproject.org
Adaptive Technology Resource Centre / University of Toronto
_______________________________________________________
fluid-work mailing list - [email protected]
To unsubscribe, change settings or access archives,
see http://fluidproject.org/mailman/listinfo/fluid-work
