Board Logo
« A Beginner's Wiki ? »

Welcome Guest. Please Login or Register.
Nov 20th, 2017, 10:20pm


Conforums Terms of Service | Membership Rules | Home | Search | Recent Posts | Notification | Format Your Message | Installation FAQ


« Previous Topic | Next Topic »
Pages: 1  Notify Send Topic Print
 thread  Author  Topic: A Beginner's Wiki ?  (Read 1251 times)
jaba
Global Moderator
ImageImageImageImageImage


member is offline

Avatar




PM

Gender: Male
Posts: 1049
xx A Beginner's Wiki ?
« Thread started on: Aug 21st, 2010, 11:39am »

Rod made this statement in a recent post on this board:
Quote:
Perhaps we need an initial paragraph that targets beginners. Then the more subtle things can be brought out.

This is a question I've been considering ever since I began contributing to the Building Blocks wiki - just how much detail should I try to include on a page?

I think I'll keep Rod's suggestion in mind for the next page I write. For instance, I may start with a statement like this:
Quote:
This command does such and such.
However, it does much more. Read on for some advanced features.

Now, I'm a detail oriented person. I want to know what's under the hood. What makes this thing do what it does. Someone else might just want to be told, "Do it this way and you'll be fine." But, who will decide just how inquisitive the next viewer might be?

My approach so far has been to try to keep the user out of trouble. If I tell him: "Do it this way." and he does but gets an error because of something I didn't tell him, then I haven't done my job very well.

In actuality, it will probably be beginners who frequent the wiki pages the most. A more advanced user might head for the Help file, or the LBPE first. That's something I had not thought much about before now.

So, thanks, Rod. I'll keep your comment in mind on my next venture into the World of Wiki.

Jack
User IP Logged

JACK - Windows 8.1 64-bit; 2.5 GHz Intel i3 processor; 6.00 GB RAM;
TyCamden
Global Moderator
ImageImageImageImageImage


member is offline

Avatar




PM

Gender: Male
Posts: 1431
xx Re: A Beginner's Wiki ?
« Reply #1 on: Aug 21st, 2010, 2:29pm »

My two cents.

Like Rod said, start the entry with a simple brief explanation and example.

Then hit the nuances later on the same page.

I have been coding basic since the early days, but am a "beginner" at GUI controls. So I would like to see the wiki satisfy all, but beginners first so they don't zone out or give up.
User IP Logged

TyCamden

Please give credit if you use code I post, no need to ask for permission.


Just BASIC 1.01, Windows 7 Home Premium version (2009), AMD Athelon II 320 Dual-Core Processor 2.10 GHz - 4.00 GB RAM (3.75 usable) - 64-bit OS
Facundo
Moderator
ImageImageImageImageImage


member is offline

Avatar




PM

Gender: Male
Posts: 1301
xx Re: A Beginner's Wiki ?
« Reply #2 on: Aug 21st, 2010, 6:49pm »

I think that building blocks are that, something to start with. The ABC of each command.

So a brief explanation would be right, then in another paragraph you could have something more complex.

Finally there are examples. You could have one simple example, with the smaller amount of code possible to explain the command.

Then, another example code, in another Code-Box showing something more advanced. The comments will be very important in this one.

The intermediate-level user will find the Useful Function very valuable.



These pages, the 'BB', will be very useful when creating a new article (not related to BB) where you can have links to each command used in the article. In fact we can embed the pages easily, or displaying a list of tags related to the article.


User IP Logged

cundo aka MSlayer
Pages: 1  Notify Send Topic Print
« Previous Topic | Next Topic »

Conforums Terms of Service | Membership Rules | Home | Search | Recent Posts | Notification | Format Your Message | Installation FAQ

Donate $6.99 for 50,000 Ad-Free Pageviews!

| |

This forum powered for FREE by Conforums ©
Sign up for your own Free Message Board today!
Terms of Service | Privacy Policy | Conforums Support | Parental Controls