A simple test paper from Chen
- 1. Documentation Designer Tips and Trips Don Kranz: Coad-Certified Mentor
- 2. Welcome A software project’s primary goal is the production of frequent, tangible, working systems. It is important to make sure that ALL of the team (Managers, Marketing, Sales, Users(production), Analysts, and Developers) know what are the goals, how they are getting there, and what to do once they've arrived. That is the reason documentation is core to a project's success. Introductions
- 3. … it is possible to write requirements and specifications that customers, testers, programmers and technical writers will actually read, understand and use. Benjamin L. Kovitz ,Practical Software Requirements: A Manual of Content and Style What’s the same … Need for accurate and maintainable documentation Andy Carmichael , Object UK Your challenge is to deliver the documentation without unduly restricting the development. …The documentation must be developed concurrently with the system. Murray R. Cantor , Object-Oriented Project Management with UML
- 4. Documentation Often the last item “thrown together” by the project team. Often not read by intended audience.
- 5. Why We Don’t Write Documentation Time consuming Not “cool” part of project Lack writing skills
- 6. Why We Don’t Read Documentation Time consuming Difficult to use Poorly written Doesn’t Match Delivered System
- 7. Documentation In Together ® Writing Time consuming Not “cool” Poor skills Reading Time consuming Difficult to use Poorly written Doesn’t Match Solution Speed doc generation Make docs easily available Tools for Tech writer Simplify finding needed information Allow implementation of best writing practices Always Matches!
- 8. Don’s DocGen Comments The DocGen utility exists to simplify the production of printed or on-line documentation for our users. We should continually improve this portion of our product with that goal in mind. Currently some things are pretty cool (very powerful) for helping the user, others require a deeper knowledge of the product, and some things are missing or just plain ugly. Working with DocGen is a great way to prepare yourself for working with Together on a deeper level. Once you start using the expression you will need to learn about the RWI openapi. Next you will want to customize the property inspector (or diagrams) which requires knowledge of the config files (or now the java source for the inspector). Then you will begin to modify the behavior of DocGen itself this leads you to the metamodel. Eventually all this will lead you to working with the API directly. Hopefully this will the encourage you to work with templates and patterns to get information into the models in the most efficient manner. All of this is focused towards making Together a more productive environment for the end user. The entire cycle seems to feed off of itself, and help improve the product as a whole.
- 10. Launching Documentation Designer Main Menu: Tools | Documentation | Design Template Generate Documentation Dialog: Design button Explorer Pane, Modules tab: Design Documentation module
- 11. DocGen Window Menu Scope Pane Area Pane
- 12. DocGen Scope
- 13. DocGen Area
- 14. DocGen Scope Page Header Report Header Details Report Footer Page Footer
- 15. Exercise 1 Build a summary introductory table that allows navigation to more detailed information.
- 16. Sample Project
- 17. Create New Report Template
- 18. New Report Template (.tpl)
- 19. File | Save As …
- 20. Set up Summary Table
- 21. Add Columns to Summary
- 22. Add Columns to Summary (2)
- 23. Insert A Formula
- 24. Test the Report
- 26. Clean up the Format
- 27. Clean up the Format (2)
- 28. Clean up the Format (3)
- 29. Clean up the Format (4)
- 30. Fix Formula Bug
- 32. Add the Detail Section Heading
- 33. Add the Details
- 35. Hyperlink Summary to Detail
- 36. Hyperlink Detail back to Summary
- 37. Run Report
- 38. Run Report
- 39. Run Report
- 40. Run Report