REBOL Technologies

Carl's REBOL Blog - Vive la REBOLution

Carl Sassenrath Carl Sassenrath, CTO
REBOL Technologies

Private feedback

1788704 visits since 12-Mar-2007

Search:

RSS

Purpose:
A few words from REBOL's architect.

Other Blogs:
REBOL 3.0 Front Line

Recent Comments::
0465 0415 0464 0065 0462 0213 0401 0463
Review all comments for week or month

Recent Articles:

11-Mar-2010 - Is there Documentation Dungeon? [0465] 10 Cmts
4-Mar-2010 - REBOL 2.7.7 SDK for OS X Intel [0464] 6 Cmts
25-Feb-2010 - AltME News and Changes [0463] 2 Cmts
13-Feb-2010 - Moved R3 Chat Server to Cheyenne in the Cloud [0462] 8 Cmts
12-Feb-2010 - IMPORTANT: R3 Chat server problem - restarted! [0461]
11-Feb-2010 - Internet speed decay -- We need a script! [0460] 9 Cmts
10-Feb-2010 - A Power Mezzanine Function Package [0459] 6 Cmts
10-Feb-2010 - Lost an important web page? [0458] 2 Cmts
6-Feb-2010 - REBOL 3 A97 Released [0457] 5 Cmts
28-Jan-2010 - REBOL Status Report 2010.2 [0456] 37 Cmts
15-Jan-2010 - REBOL 2.7.7 - Does it install correctly? [0455] 18 Cmts
Contents- Index of all articles.

11-Mar-2010 - Is there Documentation Dungeon? [0465]

Is there a documentation dungeon? I think so. I've spent countless hours working to unwind what I can only call a complete documentation disaster. This blog is a tale about how open docs can go wrong.

It all started a few years back when we selected the MediaWiki software for our DocBase open document system. No, we weren't all that excited about that choice, and the gurus debated it for a couple weeks. Finally, just to get things started, we proceeded with it, mainly because MediaWiki was available and fairly mainstream (e.g. Wikipedia is based on it.) Gabriele Santilli got it set-up and running in just a few days.

In the beginning I took the first swipe at organizing the content of DocBase. Although not perfect, it was fairly easy to find what you wanted and navigate around. However, over the years the documentation was modified and reorganized. On the surface it seemed ok. Pages were subdivided and new index directories were built by members of the community. I was happy... because users decided to participate.

But, I started to have problems finding the content I wanted. At first, I thought it was just me -- that I didn't understand the structure. As a result, over the last year, I began to avoid DocBase altogether. I couldn't find anything.

Eventually, I created the R3 Doc wiki (based on the REBOL WIP Wiki) and centralized all R3 core documentation there. It's easy to use and manage; the organization is pure and clean. There's no MySQL to mangle all the content and hog all the memory, and if I need to do something complex like batch modify a group of pages, a simple REBOL script works well.

Over the last few weeks, with the GUI project powering up again, it became necessary to review and cleanup the DocBase GUI documentation. I figured it would take me a few days. That is: two or three days. I started looking at DocBase more closely... and, frankly, it looked more like a bunch of pages dropped in a blender and mixed on purée. What a mess. It was document mismanagement on steroids.

Well, it's not been pleasant, but I've managed to sort out a lot of what I needed related to graphics and the GUI. And, the new pages are no longer in DocBase; they are now located on REBOL.com. Take a look at R3 GUI as a starting point. Yes, there's still a bit more to do -- in a few more days.

So, I've learned a few lessons about open systems... but, this was perhaps the hard way to learn them. At least I can now be positive about where we go from here. I can actually read and use the GUI docs again. Yeah!

10 Comments


4-Mar-2010 - REBOL 2.7.7 SDK for OS X Intel [0464]

The 2.7.7 SDK for Mac OS X Intel has been released.

How does it work? It's successfully built and runs AltME, a fairly large REBOL/View commercial application that uses many functions, including networking and graphics. So far, so good.

I should note that OS X SDK is a product we intend to sell (rather than give it away) and it helps fund REBOL development projects. If you're using it for company projects or products, it's quite affordable! If you're doing work for non-profit organizations or informal groups and you will help promote REBOL in some real way, send us a feedback to let us know, and we may be able to help you.

See: REBOL/SDK

6 Comments


25-Feb-2010 - AltME News and Changes [0463]

Some news from AltME.com:

  • First, the AltME.com and Safeworlds.com servers have been moved, and there was a short outage during that time while the DNS servers updated. If you're still seeing a problem, they ask that you send them a feedback message.
  • If you run your own AltME world that you start with a script or other method, the AltME name server has been improved to keep your worldname reserved as long as users login to your world a minimum of once every ten days.

See AltME News

2 Comments

View index of all articles...

Updated 12-Mar-2010   -   Copyright 2006 Carl Sassenrath   -   WWW.REBOL.COM   -   Edit   -   Blogger Source Code