On Tue, Feb 3, 2009 at 7:03 AM, Francesco Piccinno <[email protected]> wrote: > 2009/2/3 Bartosz SKOWRON <[email protected]>: >> On Tue, Feb 3, 2009 at 8:55 AM, Adriano Marques <[email protected]> wrote: >> >>> I agree with Guilherme regarding not writing development >>> documentation. Yesterday I received an e-mail of one of Umit's users >>> asking me if there was any development documentation available so she >>> could adapt Umit to her needs. It was clearly a coincidence, but I >>> don't intend to put any effort on that by now and asked her to join us >>> on our mailing list and IRC channel and there she can get some help >>> with us. I think that anyone willing to have support on Umit code is >>> better going after us than waiting for documentation, and that will >>> work fine. >> >> +1 Python is enough easy for anyone who knows something about coding. >> I would preffer more/better comments, pydocs and clean and simple code >> than developer book. >> >>> But still, I think there is the need for documentation of some >>> features. Sometimes, we may think that our interface is intuitive >>> enough but our users may not think that way. Therefore, we need to >>> prepare to them some interesting content that will help them get their >>> job done using Umit and get to know our extra features. One of the >>> examples is the plugins project. It is going to die if we don't >>> provide users any documetation. The mapper is also a good candidate >>> for documentation, because it has a lot of features and many users >>> will not figure out how it works out of the box. >> >> Yep. Plugins documentation is a crap. 2 months ago I started to write >> a plugin and I failed many times. I had a lot of questions to nopper >> about Plugins etc. Ys, it's not good enough documented. BTW. I haven't >> finished the plugin because a lot of bugs in NmapParser but gpolo >> fixed it, so i will back to this plugin someday ;) > > I don't think plugin documentation it's a crap. The point is > UmitPlugins uses few functions that I've introduced, for the rest you > have to use Umit objects, like NmapParser ScanHost etc. These are not > well documented, because UMIT was not intended to be extensible or > pluggable in origin. We have to work on get documented this object > because the UmitPlugins GUI it's pretty clear, and the introduced > functions are documented as well. In fact there are several examples > in source-plugins directory as a starting point. Probably none cares > of them. >
I think that developer documentation would not that "unnecessary" at this point, so to develop Umit Plugins, you need to know about at least about UmitCore classes functionality... I'm not intented to be pushy here, but I think it could be done quickly using sphinx + docstrings... >> >>> I think we need to help in these cases. That's why I asked that a >>> discussion on that matter would be relevant on this list. I'm sorry if >>> I wasn't clear enough in my proposal. Now, let's try it once again. >>> Which projects do you guys think that need some documentation, so we >>> can help users use Umit better and even discover features that they >>> didn't know before, or even, what sort of documetation should we >>> produce to incentivate contributions (like the plugins module)? >> >> 1. Plugins >> 2. Mapper - i think some videos would be even better than thousands of words >> 3. NetworkInventory - but I saw the screencast from our blog few days >> ago and now i think this project is more quite good "documented"... >> >> >> PS. umpa has tutorial, docs and I'm going to provide more docs soon. I >> will really back to the umpa after 15th of February as my main task >> for next few months. >> >> ------------------------------------------------------------------------------ >> Create and Deploy Rich Internet Apps outside the browser with Adobe(R)AIR(TM) >> software. With Adobe AIR, Ajax developers can use existing skills and code to >> build responsive, highly engaging applications that combine the power of >> local >> resources and data with the reach of the web. Download the Adobe AIR SDK and >> Ajax docs to start building applications today-http://p.sf.net/sfu/adobe-com >> _______________________________________________ >> Umit-devel mailing list >> [email protected] >> https://lists.sourceforge.net/lists/listinfo/umit-devel >> > > > > -- > Best regards, > Francesco Piccinno > > ------------------------------------------------------------------------------ > Create and Deploy Rich Internet Apps outside the browser with Adobe(R)AIR(TM) > software. With Adobe AIR, Ajax developers can use existing skills and code to > build responsive, highly engaging applications that combine the power of local > resources and data with the reach of the web. Download the Adobe AIR SDK and > Ajax docs to start building applications today-http://p.sf.net/sfu/adobe-com > _______________________________________________ > Umit-devel mailing list > [email protected] > https://lists.sourceforge.net/lists/listinfo/umit-devel > -- Rodolfo Carvalho Web Developer [email protected] ------------------------------------------------------------------------------ Create and Deploy Rich Internet Apps outside the browser with Adobe(R)AIR(TM) software. With Adobe AIR, Ajax developers can use existing skills and code to build responsive, highly engaging applications that combine the power of local resources and data with the reach of the web. Download the Adobe AIR SDK and Ajax docs to start building applications today-http://p.sf.net/sfu/adobe-com _______________________________________________ Umit-devel mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/umit-devel
