Thanks for all the ideas re: the help system in BoltWire. I'll try to respond to a few of them:
1) Having special help* and devhelp* pages. This is a great idea. Marcos suggested something similar awhile back and I missed it till reviewing some old emails. Since then I've been chewing on it. But for the time being I'm more inclined to try and build up our current doc pages. And plugins help should go in the plugins page, generally. I fear if we start dividing our knowledge base into help, devehelp, doc & plugin pages, etc we'll have a harder time finding what we want. 2) More how-to tutorials like the "create a blog" one. Good idea. I would like to see the docs.extend hierarchy, well extended, to include many more such topics. I think it would be a great help. Can anyone think of some examples of titles you'ld like to see there? Better yet, anyone willing to write some? 3) An out-of-date button to quickly tag pages. This is a rather practical idea. I'll be happy to write something up when I get some time. Perhaps even a notes or faq field where various kinds of messages could go. Then a docs search list displaying all pages with messages. Like "update me" or "what does this parameter do". Once the docs are fixed, you delete the note. 4) An easier to contribute wiki environment. I'm not sure I like the idea of a separate wiki environment for docs for the reasons above (#1), but I'm perfectly willing to open things up on BoltWire. Right now only those in the group @docs can edit pages, but anyone can join that group upon request. I'm willing to open that open to anyone with a member account. I have been hesitant so far as I don't really have time to manage spam. But I notice almost none in the solutions area which are member editable. We could try it awhile and see what happens. I don't have a lot of experience with open wiki's. Mine are all basically CMS's. 5) One idea not mentioned is a downloadable docs zip you can install on your wiki or farm. It would create less dependence on the main BoltWire site, but might also decrease contributions to the group documentation... I'm not inclined to put all the docs in the core,. Thanks John with the feedback on our current documentation. I personally like the new organization and feel more comfortable with it. The big thing is working towards improved thoroughness and accuracy. Another problem is I personally almost never use the documentation. I automatically revert right to the code and look there when I have a question. Which is why I like the new incode "help" system--everytime I find an answer I can jot a note right there in the core. I realize these little snippets are not extensive, but I'm open to adding additional brief, notes to the core at any time. Almost every release now has a improvement or two to the help notes. Just make your suggestion. Let's keep this discussion going until we come up with some ideas. I just opened the docs up to @member editing and will try and add an "update me" field or button or something when I get some time... Cheers, Dan --~--~---------~--~----~------------~-------~--~----~ You received this message because you are subscribed to the Google Groups "BoltWire" group. To post to this group, send email to [email protected] To unsubscribe from this group, send email to [email protected] For more options, visit this group at http://groups.google.com/group/boltwire?hl=en -~----------~----~----~----~------~----~------~--~---
