Hi, Alex: As you were writing your note, I was posting this on https://github.com/apache/royale-asjs/issues/110
I am thinking about a structure for our documentation that helps people who are new to Royale move into using the framework with satisfaction, and that helps people who are already working with it find the helpful hint they need to solve a particular problem. Structuring our documentation so people can move through it without getting lost or disheartened I think a good model for the sort of index we need is this one [1] for Adobe Flex. It leads you along from installing and getting started, through a quick build of a basic app, through concepts and features, and on to the complexities that an enterprise-grade application would have to deal with. Obviously not all of this material is relevant to Royale. At the moment I am just enjoying the way the topics are organized and lead the reader forward. I think I will start to set up a possible index in a Google Doc and open it up to comments and suggestions. [1] https://help.adobe.com/en_US/flex/using/index.html > I've been thinking that we don't want to directly copy the FlexJS pages to > > GH Pages. > I agree. However, some of that material represents low-hanging fruit that gives us a way to provide at least some documentation within the next few weeks or months. > I think the question for > > you is how much time you have and what you would like to do with your > > time. > I work as a freelance editor and writer, and I have some "interesting" clients who need a lot of attention, so I can give this effort up to ten hours a week. > I can > > certainly type in a lot of words. If your strong suit and time is better > > aimed at editing and organization, then we should find a way to make that > > work. If you have a vision of the organization of the doc and want to > put > > together the skeleton of the doc set and leave lots of placeholders, I > can > > try to fill in those placeholders and you can edit it after. > That may be a way to get the best use out of me, while extracting the best wisdom from you and others who actually know how Royale works and should work. > > > > I've looked at the Adobe doc a bit. I'm not sure that's what I want > > either, but it made me realize that we don't have pages like "What is > > MXML" and how to use it. We are for now assuming folks are > > Flex-knowledgeable, which I think is ok. > Yes...However, the folks who do the majority of the posting here may not realize how scary you seem to others who are just feeling their way. There are terms, topics, and approaches that are in common play but that a lot of people just do not understand yet. > > -- Andrew Wetmore http://cottage14.blogspot.com/
