Documentation project for PureBasic?

Everything else that doesn't fall into one of the other PB categories.

Should we create a documentation project based on a Wiki?

Yes
57
92%
No
5
8%
 
Total votes: 62

User avatar
Andre
PureBasic Team
PureBasic Team
Posts: 2137
Joined: Fri Apr 25, 2003 6:14 pm
Location: Germany (Saxony, Deutscheinsiedel)
Contact:

Post by Andre »

Amiga5k wrote:As documentations go, PB's is not the worst I've seen (BlitzMax's is really bad...), but may just need to be re-organized a bit with lots (at least one for every command) of example code. Tutorials are very helpful, too, and many more should be included in the standard distribution, IMHO.
Yes, you're right. Adding an example for (nearly) every command is hardly needed. But it's also a huge work... :?
Amiga5k wrote:Using a "I've never used ANY programming languages" approach in a "User Guide" can help get the user up and running, while the Reference Manual would delve deeper into the how's and why's of the commands. It's an approach that I've always found most useful.
This is just that, what german community is already doing. Take a look on german site of PureWiki and you will see a chapter 0 (beginning with programming in general and then continues with programming in PB).
Amiga5k wrote:The only "problem" I have with the wiki is that you would have to be online to read it (although a stand alone version could be created on a periodic basis - say every few months or so).
Of course it's planned to offer an offline edition of the PureWiki on a regular basis. Even more - useful additions should also find their way in original PB documentation.
Bye,
...André
(PureBasicTeam::Docs & Support - PureArea.net | Order:: PureBasic | PureVisionXP)
Amiga5k
Enthusiast
Enthusiast
Posts: 329
Joined: Fri Apr 25, 2003 8:57 pm

Post by Amiga5k »

This good to know! I REALLY want PB to succeed in this MSVC, C#, .Net world because I can see the advantages of it. Excellent documentation is one of the few things that stand in PB's way (The other thing is market recognition - How do we get the word out without spending tons of money on advertising? Simple: By producing many many examples of what PB can do through demos, games and whatnot and spread them around the globe!)

It can be done! Ask yourself why C succeeded so well on almost all platforms...

Russell
*** Diapers and politicians need to be changed...for the same reason! ***
*** Make every vote equal: Abolish the Electoral College ***
*** www.au.org ***
Fleath//
User
User
Posts: 47
Joined: Sun Feb 13, 2005 11:37 am
Location: Australia
Contact:

Post by Fleath// »

Would anyone mind editing the first post of this topic with all the details for this? To make it easier to contribute...I've looked through most of the topic and found the wiki on PureArea, is that the final decision?

Code: Select all

crush()
kill()
destroy()
Image
Add to PB logo to your game today.
User avatar
Andre
PureBasic Team
PureBasic Team
Posts: 2137
Joined: Fri Apr 25, 2003 6:14 pm
Location: Germany (Saxony, Deutscheinsiedel)
Contact:

Post by Andre »

Fleath// wrote:Would anyone mind editing the first post of this topic with all the details for this? To make it easier to contribute...I've looked through most of the topic and found the wiki on PureArea, is that the final decision?
Done :D
Bye,
...André
(PureBasicTeam::Docs & Support - PureArea.net | Order:: PureBasic | PureVisionXP)
Post Reply