Chen's second test slides


Published on

Published in: Business
  • Be the first to comment

  • Be the first to like this

No Downloads
Total views
On SlideShare
From Embeds
Number of Embeds
Embeds 0
No embeds

No notes for slide
  • Chen's second test slides

    1. 1. Documentation Designer Tips and Trips Don Kranz: Coad-Certified Mentor
    2. 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. 3. <ul><li>… it is possible to write requirements and specifications that customers, testers, programmers and technical writers will actually read, understand and use. </li></ul><ul><li>Benjamin L. Kovitz ,Practical Software Requirements: A Manual of Content and Style </li></ul><ul><li>What’s the same … Need for accurate and maintainable documentation </li></ul><ul><li>Andy Carmichael , Object UK </li></ul><ul><li>Your challenge is to deliver the documentation without unduly restricting the development. …The documentation must be developed concurrently with the system. </li></ul><ul><li>Murray R. Cantor , Object-Oriented Project Management with UML </li></ul>
    4. 4. Documentation <ul><li>Often the last item “thrown together” by the project team. </li></ul><ul><li>Often not read by intended audience. </li></ul>
    5. 5. Why We Don’t Write Documentation <ul><li>Time consuming </li></ul><ul><li>Not “cool” part of project </li></ul><ul><li>Lack writing skills </li></ul>
    6. 6. Why We Don’t Read Documentation <ul><li>Time consuming </li></ul><ul><li>Difficult to use </li></ul><ul><li>Poorly written </li></ul><ul><ul><li>Doesn’t Match Delivered System </li></ul></ul>
    7. 7. Documentation In Together ® <ul><li>Writing </li></ul><ul><li>Time consuming </li></ul><ul><li>Not “cool” </li></ul><ul><li>Poor skills </li></ul><ul><li>Reading </li></ul><ul><li>Time consuming </li></ul><ul><li>Difficult to use </li></ul><ul><li>Poorly written </li></ul><ul><li>Doesn’t Match </li></ul><ul><li>Solution </li></ul><ul><li>Speed doc generation </li></ul><ul><li>Make docs easily available </li></ul><ul><li>Tools for Tech writer </li></ul><ul><li>Simplify finding needed information </li></ul><ul><li>Allow implementation of best writing practices </li></ul><ul><li>Always Matches! </li></ul>
    8. 8. Don’s DocGen Comments <ul><li>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. </li></ul><ul><li>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. </li></ul><ul><li>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. </li></ul>
    9. 9. Documentation Designer
    10. 10. Launching Documentation Designer <ul><li>Main Menu: Tools | Documentation | Design Template </li></ul><ul><li>Generate Documentation Dialog: Design button </li></ul>Explorer Pane, Modules tab: Design Documentation module
    11. 11. DocGen Window Menu Scope Pane Area Pane
    12. 12. DocGen Scope
    13. 13. DocGen Area
    14. 14. DocGen Scope Page Header Report Header Details Report Footer Page Footer
    15. 15. Exercise 1 Build a summary introductory table that allows navigation to more detailed information.
    16. 16. Sample Project
    17. 17. Create New Report Template
    18. 18. New Report Template (.tpl)
    19. 19. File | Save As …
    20. 20. Set up Summary Table
    21. 21. Add Columns to Summary
    22. 22. Add Columns to Summary (2)
    23. 23. Insert A Formula
    24. 24. Test the Report
    25. 25. Initial Table Summary
    26. 26. Clean up the Format
    27. 27. Clean up the Format (2)
    28. 28. Clean up the Format (3)
    29. 29. Clean up the Format (4)
    30. 30. Fix Formula Bug
    31. 31. Test Report Again
    32. 32. Add the Detail Section Heading
    33. 33. Add the Details
    34. 34. Test Report Again
    35. 35. Hyperlink Summary to Detail
    36. 36. Hyperlink Detail back to Summary
    37. 37. Run Report
    38. 38. Run Report
    39. 39. Run Report
    40. 40. Run Report