The Documentation

[Björnke von Gierke]

Hi all

Incidentally I thought about all this when I created the BvG Docu 
stacks last spring. However, I quickly came to the conclusion that it'd 
be quite a large project to create a platform for a community driven 
Documentation. There is open source web software out there for that 
kind of stuff, and most of it is horribly complex, and not easily 
adjusted for different needs.

I think that only a very good software base, with both a web and a rev 
interface can gather enough followers to succeed. Making such a 
software would need continuous work for around half a year (if I'd make 
it (and I'm not known for doing continuous work)), with a large tail of 
feature additions and bug fixes later on.

Unfortunately, past (not very user friendly) trials by other people 
into a community driven Rev documentation have shown that there just 
where not enough contributors in the rev developer community to create 
a real documentation.

Therefore, I never really got the motivation to create even a design 
document regarding my rev-internet-docu ideas. Personally, I don't 
think anyone will make it, it's just too much hassle with few rewards. 
Maybe someone crazy (like.. err, i mean OR Andre :P) will do additional 
small trials, to be unused, or dwindle into obscurity.

So... Im out

But please try it yourself, because nothing beats having your own 
experience. Also I'll of course be available if anyone needs help in 
adjusting BvG docu or docslib. Or to contribute data entries when you 
get something useful finished.

Björnke

On 24 Oct 2007, at 18:36, Jim Ault wrote:

> Planning such an effort so it will serve well into the future is 
> difficult.
> I only mention them as food for thought and not something that should 
> delay
> progress on improving documention.
> -----
> I guess one issue could be:
> Can the documentation be used if the user is not online?
> Not everyone will be developing while connected, for various reasons.
>
> Perhaps the ability to download an updated section on libURL, or 
> arrays, or
> custom properties, for use off-line.
> ------
> Another feature 'request' would be that the entries be 
> cross-referenced to
> the [bug.RevVersion.Platform] so that improvements and fixes will have 
> notes
> that show status and history.  There are too many versions out there 
> now to
> keep track easily.
> ----------
> Of course, a working script library with the option of viewing
> --B- beginner comments
> --A- advanced comments
> --E- expert comments
> using check boxes to choose any or all
> ---------
> Moving off topic a bit..  the sample stack library, much like Rev User
> Spaces.  Again, Beginner, Adv, Expert ratings.
> Showing a working example is worth a 1000 visits to the Dictionary.  I 
> might
> be exaggerating, but not by much.
> ---------
> And getting even further off topic, back to the idea of a 'showcase' 
> of very
> good solutions, like the beginning HCard stacks, that users could 
> explore.
> ---------
> So many ways to provide documentation and inspiration.


-- 

official ChatRev page:
http://chatrev.bjoernke.com

Chat with other RunRev developers:
go stack URL "http://homepage.mac.com/bvg/chatrev1.3.rev"