Mailing List Archive: 49091 messages
  • Home
  • Script library
  • AltME Archive
  • Mailing list
  • Articles Index
  • Site search

[REBOL] Re: Documentation: Let's do it NOW!

From: SunandaDH:aol at: 10-Aug-2003 5:45

> I'm all for the project, but I need to focus my free time on the > Library project first. I'll be happy to comment and work on the > Library side of things. Whether the Library becomes the hub, or the > other way around, a central doc station would be a terrific thing IMO.
Me too (or do I mean loop 2 [print "me"]) I see a documentation project as highly complementary to the planned next phase of the Library. The Library is unlikely to become a hub for documentation -- it'll be a hub for **scripts** which *can* be fully documented. Example: there may be some scripts doing clever things with parse, and the authors have added extensive notes about how those clever things work. But it won't be a hub for a "parse for dummies" document -- a document that explores parse in all its depth and may have many code examples embedded within it. A few things could be in either or both. For example, I have a (not yet finished) "industrial strength" logging script (handles all sorts of error conditions and stuff) which I worked up from a one-liner. Plus I have all the notes of why each change and complication was added. That could be a script Library entry with a fully documented rationale, or a documentation project entry on error trapping and real-world event handling with a full script development history. Good luck with the documentation project, guys! Sunanda.