yade-users team mailing list archive

[Mohammad Nurul Islam <nislamce@xxxxxxxxx>]

Hi,
Preparation of YADE documentation will be a good step for new users.I have some own documentation that I have prepared with respect to PFC and OVAL and some other open source DEM code, manual. And I guess other YADE users also have such types of documentation.If we share each others documentations, it will enrich YADE resource.

Ofcourse there are some documentation on YADE, but for new users it is questionable, how much it will be helpful !!!

Regards,
Mohammad Nurul Islam

--- On Tue, 6/23/09, Anton Gladky <gladky.anton@xxxxxxxxx> wrote:

From: Anton Gladky <gladky.anton@xxxxxxxxx>
Subject: [Yade-users] YADE documentation
To: "Yade Development Group" <yade-users@xxxxxxxxxxxxxxxxxxx>
Date: Tuesday, June 23, 2009, 8:38 AM

Hi all!

I have some thoughts on YADE documentation.

I am working with YADE not so much time. But the main thing, what waste a lot of time, is the insufficient documentation. I'm sure it stops a lot of new potential users and (probably) developers.




So my guess is, that it would be good to start from creating short but informative instructions or howtos for different tasks. It should include short description how to do it and good examples with comments. I like style which has been used for C++ tutorial http://www.cplusplus.com/doc/tutorial/




I am ready to write some of such documents, but my YADE knowledges are yet not so deep.

I think it is an important to have a good and easy-understandable documentation.

______________________________



[ENG] Best Regards
[GER] Mit freundlichen Grüßen
[RUS] С наилучшими пожеланиями
[UKR] З найкращими побажаннями

Anton Gladkyy




-----Inline Attachment Follows-----

_______________________________________________
Mailing list: https://launchpad.net/~yade-users
Post to     : yade-users@xxxxxxxxxxxxxxxxxxx
Unsubscribe : https://launchpad.net/~yade-users
More help   : https://help.launchpad.net/ListHelp