Hilarion wrote:
>
> On 12-Jun-98 John R Sheets playfully chanted:
> | Gotcha. Maybe I'll look into writing up/maintaining a quick
> | little module-by-module tour of the code....keep it all in a
> | separate text document or something. Gotta find time, tho.... I
> | would safely assume nothing like that is currently underway....?
> | (c: Thought not...
> |
> | Anyway, is the code for E14 a radical departure from the E14 demo
> | (ignoring test.c)? Or would the demo be a good place to at least
> | start on something like this?
>
> I briefly played with the idea, but I wanted to concentrate on the people
> coming in to the entire E thing with no previous programming experience, or at
> least a quick (but shallow) reference.
>
> If/when you get the time, and put it together, play hot potatoe with me and
> I'll SGMLize it and put it in with the other stuff I've done, doc-wise, as
> another (developer?) section. I can organize it for you too if that's a pain
> or it would speed you up, since I'd have to do a bit of that anyway.
>
> It might be a good idea to get some sectional strategy going (ie, two major
> headings come to mind: 'accessible' and 'deep', so that those who only want to
> get in hip-deep can without wading through a lot of what they would consider
> thick water). These are suggestions only, of course. ;}~
Sounds like a good idea(s). I was kind of envisioning a simple
intro section (Roadmap?) that lists each module with a sentence
or two explaining the general useage of the module; another
section (Architecture?) would explain (in paragraph form) how the
modules interact. A third section (Implementation?) would take
each module apart, function by function, and explain how the
function is used, when, and if they should even be called
directly (i.e. is it a helper function, etc.).
Volume-wise, I'd anticipate 1-2 pages for Roadmap, 3-8 pp. for
Architecture, and <who-the-hell-knows-ask-raster> pp. for
Implementation. Naturally, it'll be a very liquid document until
E14 stablizes, and until I get the model(s) straight in my own
head. HEAVY peer reviews/revisions.
And I'm ALWAYS open to suggestions. (c:
Sound like a decent plan?
John
P.S--Any thoughts on an official title for the document?
E-Tour? Enlightendoc? E-mancipation? (c:
-
To unsubscribe from this list send mail to: [EMAIL PROTECTED]
with the message contents: unsubscribe e-develop
