Hi, all:
I want to start upgrading the very useful documentation we have that
currently refers to FlexJS [1]. At the very least every document needs
edits to make sure it refers to Royale.
However, there are some other considerations:
- Is there material that needs to be rewritten because Royale has
evolved away from FlexJS? I will need help identifying stuff that is out of
phase with the current project.
- The existing material is good, but not comprehensive. I'll be happy to
help extend the documentation, building out along the lines indicated by
the stub table of contents here: [2]. However, I am primarily a writer who
dabbles in code, rather than a coder who writes. I see two ways forward:
- I write material using my naive best-guess approach and my library
of Flex resources, and then people who are actually, you know,
smart about
this stuff help me correct all my gaffes and oversights.
- People who know the code blurt out their information on a
particular topic without worrying too much about polishing it, and then I
help rework it until it is attractive and informative to the intended
audience.
- There should be a new blog entry every week at least so there is
almost always something fresh for a site visitor to enjoy. I can think of
lots of titles, but probably do not have the technical smarts to get all
the details right.
This leaves to one side for the moment the question of whether we are using
MarkDown or HTML for the documentation pages, although I think it is clear
we are not using a wiki.
1. https://cwiki.apache.org/confluence/display/FLEX/Flex+JS
2. https://github.com/olafkrueger/flexjs-docs/wiki
--
Andrew Wetmore
http://cottage14.blogspot.com/
