Menu
▾
▴
Re: [Qscada-developers] R: Document templates
|
From: wireless <wir...@ta...> - 2006-12-13 17:53:38
|
Paolo Sereno wrote: > Hi all, >=20 > thank you for your effort and your ideas. I=B4m honoured to work with y= ou all. >=20 Hello Paolo, > Talking about coding convention, I=B4d like to invite you to consider s= omething like this > http://www.cs.rice.edu/~dwallach/CPlusPlusStyle.html It looks reasonable to me. If after we start coding it does not address a particular need, we can discuss that need, modify the scheme (document) and move on. I like the structured approach, as long as we can discuss and update our guiding docs, once we are in agreement. So that's a YES vote. > Source structure: > I agree with you, but I think is not necessary to put my name, I think = is better to put=20 the name of the sw developer who wrote it. Agreed. A revision history could look like this Paolo 13sep06 james 19sep06 Jovan 11nov06 Iain 12dec06 Some mechanism to archive the document before the given revision are made, should be simple to establish. What I do is just duplicate the master file with a copy that has a date extension in the filename, the date of modifcation. Then the next time I edit the doc, the duplicate with the extension gets archive (manually for me) and the current file has (2) copies, one with the doc name, the second with the doc name plus the date of modification extension, right in the filename. just a thought. ? >=20 >=20 > Documents: > When I wrote the first vision document draft I tried to make it clean a= nd simple as much as possible. I think this is what we need in principle. Concerning fonts and templates I=B4ll look if there are any standard we can use. Any idea is welcome at this stage. Yes, I just had trouble using it as a template, some of the auto formating, indexing, outline functions did not work correctly with open office..... But, as other take a document and modify it, we'll flesh out these idiosyncrasies. >=20 > Talking about GUI, yes, I=B4d like to use Qt (GPL version) and the scri= pting engine QSA.=20 I think Qt+QSA can help us to make QScada flexible and powerful. Well, I have no experience with QSA, but, it looks fine from what this page says: http://www.trolltech.com/products/qt/addon/qsa >=20 >=20 > Take care, > paolo >=20 I also like Jovan's suggestions below. Do they conflict with what you are presenting here Paolo? To me they are complimentary. What we need to do is say, here james here is a document. Take it and keep/modify sections 1-3 and 4 and beyond just follow the mechanics of the existing doc. I took one of Paolo's document and tried to just modify it for the hardware doc I sent to the group some time ago. My setup in OpenOffice gaged on some issues. Are we all using OpenOffice? Office on windows can give fits for documents when loaded into OpenOffice. Alternatively, I can just submit content in some agreeable form and somebody can put the content into a template form? I really do not care so much as to the details of how we do this as much as I care about a simple, quick method, so when I get time I can document my work. A lot of what I see myself doing is developing examples, that are centric around actual pieces of hardware, kind of a 'hardware dev kit for Qscada' as to attract other to participate with Qscada. For example, I need to develop or find an existing program to take brand new cisco and Adtran routers out of the box, connect to them using a rs232 serial port, and run a program to so a technician can enter a few pieces of information, and the router will be 'auto_magically' setup to run on a controls network. I'll first document the steps from a linux system, testing the validity of the steps manually. Then I'll script it, write ansi C code, and then finally develop some gui eye candy interface, using java. I could use QT-QSA too? Think about what I'll need and how I should do this, so that QScada can use/leverage the work for Qscada. After all, setting up routers, PLCs, targets(embedded linux systems) is all part of running a large controls network.... I willing to be the 'test_case'. The documents I end up with should be usable with Qscada. thoughts? James >=20 >=20 >=20 > ----- Messaggio originale ----- > Da: Jovan Kostovski <cho...@gm...> > A: qsc...@li... > Inviato: Mercoled=EC 29 novembre 2006, 17:16:53 > Oggetto: [Qscada-developers] Document templates >=20 > Hi all, >=20 > As we said, we need some templates for the documents. >=20 > What kind of templates do we need? > 1. Source code templates > 2. Document templates for documentation, propositions etc. > ... > ... >=20 >=20 > Which parts should we discuss about the document structure >=20 > 1. Sources: > - header comment > - filename > - description > - author ?? ((we'll probably put Paolo's name here, as he > is the project leader) > - revision history > - license > - code formatting > - naming conventions > ... > ... > ... >=20 > 2. General Document contents: > - front page layout > - table of contents > - header > - footer > - fonts to be used ?? > - pictures / diagrams which programs to use for creating them > ... > ... > ... >=20 > Ideas/ Suggestions ??? >=20 >=20 > GREETZ, Jovan >=20 > -----------------------------------------------------------------------= -- > Take Surveys. Earn Cash. Influence the Future of IT > Join SourceForge.net's Techsay panel and you'll get the chance to share= your > opinions on IT & business topics through brief surveys - and earn cash > http://www.techsay.com/default.php?page=3Djoin.php&p=3Dsourceforge&CID=3D= DEVDEV > _______________________________________________ > Qscada-developers mailing list > Qsc...@li... > https://lists.sourceforge.net/lists/listinfo/qscada-developers >=20 >=20 >=20 >=20 > __________________________________________________ > Do You Yahoo!? > Poco spazio e tanto spam? Yahoo! Mail ti protegge dallo spam e ti da ta= nto spazio gratuito per i tuoi file e i messaggi=20 > http://mail.yahoo.it=20 >=20 > -----------------------------------------------------------------------= -- > Take Surveys. Earn Cash. Influence the Future of IT > Join SourceForge.net's Techsay panel and you'll get the chance to share= your > opinions on IT & business topics through brief surveys - and earn cash > http://www.techsay.com/default.php?page=3Djoin.php&p=3Dsourceforge&CID=3D= DEVDEV > _______________________________________________ > Qscada-developers mailing list > Qsc...@li... > https://lists.sourceforge.net/lists/listinfo/qscada-developers >=20 |
