REBOL Technologies

Clarifying the Document Structure

Carl Sassenrath, CTO
REBOL Technologies
24-Feb-2009 18:43 GMT

Article #0393
Main page || Index || Prior Article [0392] || Next Article [0394] || 6 Comments || Send feedback

I wanted to clarify the structure of the new REBOL 3 Documentation. Since it currently consists of more than 740 pages, it's good to understand why it is structured in a specific way.

I've written this document, Document Structure and Objectives, to provide a permanent explanation of the document's objectives and design.

First, I will admit that I was influenced by the Apple OS X manuals. I've found them to be helpful, generally well written and structured. So, I wanted to model the the new doc system in a similar way (although our docs are certainly not of the OS X magnitude.)

As I've noted before, I also like the sidebar navigation. We had it in our first manual, then we removed it for some long forgotten reason. We don't have it yet on the new docs, but you can expect to see it soon. We'd also like to add a hide button for it, in case you find it distracting or want to print the page.

And finally, I should note again that this is a huge document... and it takes incredible amounts of time and energy to deal with it. There are still many missing pieces and older sections that need editing. You will need to either be patient as things progress, or step forward and help the project move forward. Thanks.

6 Comments

Updated 23-Nov-2017   -   Copyright Carl Sassenrath   -   WWW.REBOL.COM   -   Edit   -   Blogger Source Code