Let me admit, most annoying part of full development life cycle is when I need to write Technical documentation. To avoid this recurring task(boring as well ;)...) I created Technical document generator utility. Thanks to my colleagues(Prahlad & Raj) who also contributed to this work.
I'm sure even they would appreciate writing a blog on this task.
Let me be clear what you will get with this utility.
It would list down;
- All the model artifacts, e.g Entity object, view object, application module ,package structure, class files.
- All(almost all) validation rules defined on entity objects.
- View accessors & list of values defined on an entity/view objects.
- Entity/View object attributes, any expressions defined over them.
No software/utility is perfect & cover all the scenarios. So you may need to modify & use as per your requirement. But this blog should give you fair enough idea on how to get around them.
Steps to uptake this utility:
- Create a temporary application module & add all the view objects in the application.
- Generate AMImpl for the temporary application module.
- Copy paste code below.
- Expose client interface methods writeAllEntityObjects & writeAllViewObjects.
- Run them directly from Application module tester.
- All your code is generated in server console. Copy code to a file & save as html.
Hope this helps!!!
