chen's second test slides
TRANSCRIPT
![Page 1: Chen's second test slides](https://reader034.vdocument.in/reader034/viewer/2022042602/55984e821a28ab3c6d8b4852/html5/thumbnails/1.jpg)
1
Documentation Designer
Tips and Trips
Don Kranz: Coad-Certified Mentor
![Page 2: Chen's second test slides](https://reader034.vdocument.in/reader034/viewer/2022042602/55984e821a28ab3c6d8b4852/html5/thumbnails/2.jpg)
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 2
![Page 3: Chen's second test slides](https://reader034.vdocument.in/reader034/viewer/2022042602/55984e821a28ab3c6d8b4852/html5/thumbnails/3.jpg)
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 documentationAndy 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
3
![Page 4: Chen's second test slides](https://reader034.vdocument.in/reader034/viewer/2022042602/55984e821a28ab3c6d8b4852/html5/thumbnails/4.jpg)
4
Documentation
• Often the last item “thrown together” by the project team.
• Often not read by intended audience.
4
![Page 5: Chen's second test slides](https://reader034.vdocument.in/reader034/viewer/2022042602/55984e821a28ab3c6d8b4852/html5/thumbnails/5.jpg)
5
Why We Don’t Write Documentation
• Time consuming
• Not “cool” part of project
• Lack writing skills
5
![Page 6: Chen's second test slides](https://reader034.vdocument.in/reader034/viewer/2022042602/55984e821a28ab3c6d8b4852/html5/thumbnails/6.jpg)
6
Why We Don’t Read Documentation
• Time consuming
• Difficult to use
• Poorly written–Doesn’t Match Delivered System
![Page 7: Chen's second test slides](https://reader034.vdocument.in/reader034/viewer/2022042602/55984e821a28ab3c6d8b4852/html5/thumbnails/7.jpg)
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!
![Page 8: Chen's second test slides](https://reader034.vdocument.in/reader034/viewer/2022042602/55984e821a28ab3c6d8b4852/html5/thumbnails/8.jpg)
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.
![Page 9: Chen's second test slides](https://reader034.vdocument.in/reader034/viewer/2022042602/55984e821a28ab3c6d8b4852/html5/thumbnails/9.jpg)
9
Documentation Designer
![Page 10: Chen's second test slides](https://reader034.vdocument.in/reader034/viewer/2022042602/55984e821a28ab3c6d8b4852/html5/thumbnails/10.jpg)
10
Launching Documentation Designer
Main Menu: Tools | Documentation | Design Template
• Generate Documentation Dialog: Design button
Explorer Pane, Modules tab: Design Documentation module
![Page 11: Chen's second test slides](https://reader034.vdocument.in/reader034/viewer/2022042602/55984e821a28ab3c6d8b4852/html5/thumbnails/11.jpg)
11
DocGen Window
Menu
Scope Pane Area Pane
![Page 12: Chen's second test slides](https://reader034.vdocument.in/reader034/viewer/2022042602/55984e821a28ab3c6d8b4852/html5/thumbnails/12.jpg)
12
DocGen Scope
![Page 13: Chen's second test slides](https://reader034.vdocument.in/reader034/viewer/2022042602/55984e821a28ab3c6d8b4852/html5/thumbnails/13.jpg)
13
DocGen Area
![Page 14: Chen's second test slides](https://reader034.vdocument.in/reader034/viewer/2022042602/55984e821a28ab3c6d8b4852/html5/thumbnails/14.jpg)
14
DocGen Scope
Page Header
Report Header
Details
Report Footer
Page Footer
![Page 15: Chen's second test slides](https://reader034.vdocument.in/reader034/viewer/2022042602/55984e821a28ab3c6d8b4852/html5/thumbnails/15.jpg)
15
Exercise 1
Build a summary introductory table that allows navigation to more detailed information.
![Page 16: Chen's second test slides](https://reader034.vdocument.in/reader034/viewer/2022042602/55984e821a28ab3c6d8b4852/html5/thumbnails/16.jpg)
16
Sample Project
![Page 17: Chen's second test slides](https://reader034.vdocument.in/reader034/viewer/2022042602/55984e821a28ab3c6d8b4852/html5/thumbnails/17.jpg)
17
Create New Report Template
![Page 18: Chen's second test slides](https://reader034.vdocument.in/reader034/viewer/2022042602/55984e821a28ab3c6d8b4852/html5/thumbnails/18.jpg)
18
New Report Template (.tpl)
![Page 19: Chen's second test slides](https://reader034.vdocument.in/reader034/viewer/2022042602/55984e821a28ab3c6d8b4852/html5/thumbnails/19.jpg)
19
File | Save As …
![Page 20: Chen's second test slides](https://reader034.vdocument.in/reader034/viewer/2022042602/55984e821a28ab3c6d8b4852/html5/thumbnails/20.jpg)
20
Set up Summary Table
![Page 21: Chen's second test slides](https://reader034.vdocument.in/reader034/viewer/2022042602/55984e821a28ab3c6d8b4852/html5/thumbnails/21.jpg)
21
Add Columns to Summary
![Page 22: Chen's second test slides](https://reader034.vdocument.in/reader034/viewer/2022042602/55984e821a28ab3c6d8b4852/html5/thumbnails/22.jpg)
22
Add Columns to Summary (2)
![Page 23: Chen's second test slides](https://reader034.vdocument.in/reader034/viewer/2022042602/55984e821a28ab3c6d8b4852/html5/thumbnails/23.jpg)
23
Insert A Formula
![Page 24: Chen's second test slides](https://reader034.vdocument.in/reader034/viewer/2022042602/55984e821a28ab3c6d8b4852/html5/thumbnails/24.jpg)
24
Test the Report
![Page 25: Chen's second test slides](https://reader034.vdocument.in/reader034/viewer/2022042602/55984e821a28ab3c6d8b4852/html5/thumbnails/25.jpg)
25
Initial Table Summary
![Page 26: Chen's second test slides](https://reader034.vdocument.in/reader034/viewer/2022042602/55984e821a28ab3c6d8b4852/html5/thumbnails/26.jpg)
26
Clean up the Format
![Page 27: Chen's second test slides](https://reader034.vdocument.in/reader034/viewer/2022042602/55984e821a28ab3c6d8b4852/html5/thumbnails/27.jpg)
27
Clean up the Format (2)
![Page 28: Chen's second test slides](https://reader034.vdocument.in/reader034/viewer/2022042602/55984e821a28ab3c6d8b4852/html5/thumbnails/28.jpg)
28
Clean up the Format (3)
![Page 29: Chen's second test slides](https://reader034.vdocument.in/reader034/viewer/2022042602/55984e821a28ab3c6d8b4852/html5/thumbnails/29.jpg)
29
Clean up the Format (4)
![Page 30: Chen's second test slides](https://reader034.vdocument.in/reader034/viewer/2022042602/55984e821a28ab3c6d8b4852/html5/thumbnails/30.jpg)
30
Fix Formula Bug
![Page 31: Chen's second test slides](https://reader034.vdocument.in/reader034/viewer/2022042602/55984e821a28ab3c6d8b4852/html5/thumbnails/31.jpg)
31
Test Report Again
![Page 32: Chen's second test slides](https://reader034.vdocument.in/reader034/viewer/2022042602/55984e821a28ab3c6d8b4852/html5/thumbnails/32.jpg)
32
Add the Detail Section Heading
![Page 33: Chen's second test slides](https://reader034.vdocument.in/reader034/viewer/2022042602/55984e821a28ab3c6d8b4852/html5/thumbnails/33.jpg)
33
Add the Details
![Page 34: Chen's second test slides](https://reader034.vdocument.in/reader034/viewer/2022042602/55984e821a28ab3c6d8b4852/html5/thumbnails/34.jpg)
34
Test Report Again
![Page 35: Chen's second test slides](https://reader034.vdocument.in/reader034/viewer/2022042602/55984e821a28ab3c6d8b4852/html5/thumbnails/35.jpg)
35
Hyperlink Summary to Detail
![Page 36: Chen's second test slides](https://reader034.vdocument.in/reader034/viewer/2022042602/55984e821a28ab3c6d8b4852/html5/thumbnails/36.jpg)
36
Hyperlink Detail back to Summary
![Page 37: Chen's second test slides](https://reader034.vdocument.in/reader034/viewer/2022042602/55984e821a28ab3c6d8b4852/html5/thumbnails/37.jpg)
37
Run Report
![Page 38: Chen's second test slides](https://reader034.vdocument.in/reader034/viewer/2022042602/55984e821a28ab3c6d8b4852/html5/thumbnails/38.jpg)
38
Run Report
![Page 39: Chen's second test slides](https://reader034.vdocument.in/reader034/viewer/2022042602/55984e821a28ab3c6d8b4852/html5/thumbnails/39.jpg)
39
Run Report
![Page 40: Chen's second test slides](https://reader034.vdocument.in/reader034/viewer/2022042602/55984e821a28ab3c6d8b4852/html5/thumbnails/40.jpg)
40
Run Report