The document provides tips for documentation design in software projects. It discusses why documentation is important for project success and ensuring all team members understand goals and responsibilities. It also addresses common reasons why documentation is not written or read, such as being time-consuming or not matching the delivered system. The document demonstrates how to generate documentation using a DocGen utility and create a template with a summary table that allows navigation to more detailed information sections.

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

9. Documentation Designer

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

25. Initial Table Summary

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

31. Test Report Again

32. Add the Detail Section Heading

33. Add the Details

34. Test Report Again

35. Hyperlink Summary to Detail

36. Hyperlink Detail back to Summary

37. Run Report

38. Run Report

39. Run Report

40. Run Report