Best Practices: Cross-Platform Documentation

[Guest.Visitor]

Talk about dinosaur. What's the first thing that pops into my head when I read binder? Three rings and lots of paper Ha! Too funny. I should have known better what you meant. Sorry about that. Tom

[Guest.Visitor]

In fact, with Mediawiki Wiki software you can store any kind of document or data in the wiki and keep multiple versions. I did a session at Anaheim on installing & using a wiki for maintaining documentation for multiple platforms, including As400. The people from Zend had a demonstration project up of running Mediawiki on as400 - I'm not sure if it was running on mysql, or if the code had been modified to use db2/400..

[jacobus]

The reason is that code in Java is much more split up in little pieces (it should anyway), it's more granular. So when documenting each method and class the javadoc can produce nice docs which have also a clear context (a class, a method, etc). But in RPG, programs are much more monolithic. So this only works when the program is devided in little procedures/subroutines (preferably only procedures of course) which are nicely focused (do just one thing) and have clear names. The source needs to be "self-documenting" before an RPG doc utility would have any use (after all it's just a simple tool). Comments for procedures/subroutines etc can be filtered out of course and placed in a document but there is much less context as in a java program. gr. jacobus

[MCWebsite.Staff]

** This thread discusses the Content article: Best Practices: Cross-Platform Documentation **
0---0