AltME: Red Docs


This group is for the discussion of Red documentation. I think it's important enough, and will generate enough chat, that it deserves its own group. See #Red for previous doc chat.
Presentation is important.
Completeness is important.
Explanations are important.
Examples are important.
Presentation, please nothing fancy with popups on mouseover events. (besides who uses mice on tablets in future)
But needed is a good design, graphical eyecandy, make it attractive.
Explanations as why Red does things in its own way. Background information, summarize discussions on the topic. etc.
Examples, like completeness says it all. Good examples say more than a 1000 words.
I think that REBOL has good structure of reference documentation, we should copy and enhance it eventually ....
Thanks Gregg, having a separate group will be helpful, it's a broad topic anyway.

Maybe talking about this is too early, but if there is a easy way to support localization, that would be great. We hope Red's Documentation can be translated into Chinese, Japanese, ...
I do like a lot of the REBOL docs, which took time and effort to create. Wikis are good for reference information. I agree with Arnold that good examples are important. I'll add that giving people a starting point is helpful. For example, have example scripts for different types of apps or features; CGI, pipe and filter, command line handling, etc.
I also think format fragmentation is bad. REBOL's docs are fragmented, which makes it hard to know the best place to put something. Being able to share data, or have a common doc db that can be rendered in different ways, would be great.
Gregg - totally agree on avoiding doc fragmentation. This is a serious consideration for newcomers who need a guiding hand to see the overall picture. It's pretty important to convey a sense of being authoritative on documentation. Another related issue is that of keeping documentation current/clean. Old, deprecated, outdated material should be deleted or at least be made a lot less visible in the community.
If there is really outdated documentation it should not made invisible, but marked as obsolet since when.
Maybe some programs were made with special features relying on that old behavior.
When I was trying to learn REBOL, the most helpful document was the cookbook,
Different subjects, but covers almost all the subjects, and they are all complete. If we do something like that and give links to related wiki pages about the topic of the example, it would be a great way to learn RED for beginners.
And the most difficult thing was the fragmented docs, we should avoid that..
Carl wrote a number of examples in his blog early on. They were very helpful to me as well.
"And the most difficult thing was the fragmented docs, we should avoid that." - I suggest also later on that Red provides functions directly in the interpreter to invoke any official help documents.
The best way for documentation is a wiki, where people can easily ragiter, log in and edit.
Arnold, you can make popups with copy and paste possibility - check this quick remake of the original Carl's reference page:
Here is script which I used to cerate it... note that there are not existing links in Carl's reference (in the GUI section). Hope Red will have documentation without such a silly errors.
And regarding version for tablets, I believe that it's better to have separate version for tablets which would better work with the limited screen resolution. I can imagine nice looks for that as well.. it just need to have nicely structured and centralised documentation data which can be used as a source for different looks.

Last message posted 65 weeks ago.