Might I also suggest you build a small 'compatibility tool' similar to that which they use for the Wordpress plugin repository? I think this would be a great feature for both plugins and documents alike. Naturally the best possible implementation would be to integrate it with various notification functions.
If you even made past (major) revisions publicly available, the docs would even be better prepared for changed folder names and such. Imagine I'm using BoltWire 3.4, and I'm not in a good position to upgrade to 4.0 atm. I find a page about naming conventions that I want to read up on. The page says "4.0 + r46 = works!". I change the version to 3.4, and it says "= doesn't work!". I proceed by ticking the revisions down one by one. When I reach r30 it says "= works!". To recap, "3.4 + r30 = works!". Now I click "view older revisions" somewhere, I select r30 and PRESTO, legacy documentation comes in handy :D On Mar 25, 7:43 pm, The Editor <[email protected]> wrote: > Just a few comments on this thread... > > First, I'm very encouraged by the input and the willingness of > everyone to pitch in. Great! I'm really happy to support this--esp the > part about not having developers not writing the docs! Cheers for > maintainers! > > Second, Lino is right--one factor has been our rate of change. We need > more contributions, for sure, but we also need to slow development. Ny > recommendation is to aim for 4.xx however, and stop there, rather than > 3.5. We are actually quite close already and I am already planning to > stop development there anyway for a good long while. Besides, other > than forms, there shouldn't be much change between 3.5 and 4.0. > > Markus, I want to do a little reorganizing of the docs involving the > barn/handbook, the getting starting pages, and our upcoming site.help > pages. Once I find some time to do that, I'll add the data field you > suggest. I have a script for doing that easily... We can then begin > checking through the docs. We can also setup some pages to monitor > changes by others, new pages, etc. > > Along these lines, I definitely plan to recheck the notifications > plugin, and activate it for the docs for anyone that wants to > participate. It should definitely help improve the quality and > encourage more discussion of the docs pages. I'm surprized sometimes > to see changes in the docs, I didn't make. Notifications can help us > watch these changes better, and maybe even open up the editing more. > > Finally, I like the guidelines for documentation Markus has suggested. > While we don't want to be overly brief or abrupt with our text, using > shorter sentences, bullets, headlines, tables, outlines and the like > does make it easier to scan and find information. Thanks for putting > up the guidelines--though I wonder if they couldn't be combined with > docs.contribute and put on one page... > > So keep up this thread. Feel free to take over the docs--and make it > into a true community project. I'll focus on the code and try and get > us stabilized at a good solid 4.00 asap. > > 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.
