SlideShare a Scribd company logo
1 of 40
Documentation Designer Tips  and Trips Don Kranz: Coad-Certified Mentor
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
[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]
Documentation ,[object Object],[object Object]
Why We Don’t  Write   Documentation ,[object Object],[object Object],[object Object]
Why We Don’t  Read  Documentation ,[object Object],[object Object],[object Object],[object Object]
Documentation In Together ® ,[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]
Don’s DocGen Comments ,[object Object],[object Object],[object Object]
Documentation Designer
Launching Documentation Designer ,[object Object],[object Object],Explorer Pane, Modules tab: Design Documentation module
DocGen Window Menu Scope Pane Area Pane
DocGen Scope
DocGen Area
DocGen Scope Page Header Report Header Details Report Footer Page Footer
Exercise 1 Build a summary introductory table that allows navigation to more detailed information.
Sample Project
Create New Report Template
New Report Template (.tpl)
File | Save As …
Set up Summary Table
Add Columns to Summary
Add Columns to Summary (2)
Insert A Formula
Test the Report
Initial Table Summary
Clean up the Format
Clean up the Format (2)
Clean up the Format (3)
Clean up the Format (4)
Fix Formula Bug
Test Report Again
Add the Detail Section Heading
Add the Details
Test Report Again
Hyperlink Summary to Detail
Hyperlink Detail back to Summary
Run Report
Run Report
Run Report
Run Report

More Related Content

What's hot

Adobe DITA World: Templates, DITA, and FrameMaker 2015
Adobe DITA World: Templates, DITA, and FrameMaker 2015Adobe DITA World: Templates, DITA, and FrameMaker 2015
Adobe DITA World: Templates, DITA, and FrameMaker 2015Publishing Smarter
 
What can we do to create more Efficient Model Based Collaboration
What can we do to create more Efficient Model Based CollaborationWhat can we do to create more Efficient Model Based Collaboration
What can we do to create more Efficient Model Based CollaborationAlan Didcock
 
Software Craftsmanship @ Ntnu
Software Craftsmanship @ NtnuSoftware Craftsmanship @ Ntnu
Software Craftsmanship @ Ntnugoeran
 
Choosing the right software
Choosing the right softwareChoosing the right software
Choosing the right softwarewardjo
 
Microsoft power point
Microsoft power pointMicrosoft power point
Microsoft power pointShahid Nur
 
The 5 Stages of Software Development
The 5 Stages of Software DevelopmentThe 5 Stages of Software Development
The 5 Stages of Software DevelopmentSterling Technolabs
 
Being Smart at agile. A brief introduction to Capgemini's Accelerated Deliver...
Being Smart at agile. A brief introduction to Capgemini's Accelerated Deliver...Being Smart at agile. A brief introduction to Capgemini's Accelerated Deliver...
Being Smart at agile. A brief introduction to Capgemini's Accelerated Deliver...Sander Hoogendoorn
 
Agile Development Practice
Agile Development PracticeAgile Development Practice
Agile Development PracticeKshitiz Goel
 
OnlineProject2_Schedule_Engl313_Spring2019
OnlineProject2_Schedule_Engl313_Spring2019OnlineProject2_Schedule_Engl313_Spring2019
OnlineProject2_Schedule_Engl313_Spring2019Shannon Dryden
 
How to be proud when you are done
How to be proud when you are doneHow to be proud when you are done
How to be proud when you are doneMikalai Alimenkou
 

What's hot (11)

Adobe DITA World: Templates, DITA, and FrameMaker 2015
Adobe DITA World: Templates, DITA, and FrameMaker 2015Adobe DITA World: Templates, DITA, and FrameMaker 2015
Adobe DITA World: Templates, DITA, and FrameMaker 2015
 
What can we do to create more Efficient Model Based Collaboration
What can we do to create more Efficient Model Based CollaborationWhat can we do to create more Efficient Model Based Collaboration
What can we do to create more Efficient Model Based Collaboration
 
Software Craftsmanship @ Ntnu
Software Craftsmanship @ NtnuSoftware Craftsmanship @ Ntnu
Software Craftsmanship @ Ntnu
 
Choosing the right software
Choosing the right softwareChoosing the right software
Choosing the right software
 
Microsoft power point
Microsoft power pointMicrosoft power point
Microsoft power point
 
The 5 Stages of Software Development
The 5 Stages of Software DevelopmentThe 5 Stages of Software Development
The 5 Stages of Software Development
 
Being Smart at agile. A brief introduction to Capgemini's Accelerated Deliver...
Being Smart at agile. A brief introduction to Capgemini's Accelerated Deliver...Being Smart at agile. A brief introduction to Capgemini's Accelerated Deliver...
Being Smart at agile. A brief introduction to Capgemini's Accelerated Deliver...
 
Agile Development Practice
Agile Development PracticeAgile Development Practice
Agile Development Practice
 
OnlineProject2_Schedule_Engl313_Spring2019
OnlineProject2_Schedule_Engl313_Spring2019OnlineProject2_Schedule_Engl313_Spring2019
OnlineProject2_Schedule_Engl313_Spring2019
 
How to be proud when you are done
How to be proud when you are doneHow to be proud when you are done
How to be proud when you are done
 
Agile scrum using ms teams o365 mn
Agile scrum using ms teams o365 mnAgile scrum using ms teams o365 mn
Agile scrum using ms teams o365 mn
 

Viewers also liked

Enterprise 2.0 With Plone
Enterprise 2.0 With PloneEnterprise 2.0 With Plone
Enterprise 2.0 With Plonevirginiachoy
 
Mengagas Masyarakat Komunikatif (Perspektif Bahasa dalam Ruang Generasi Muda)
Mengagas Masyarakat Komunikatif (Perspektif Bahasa dalam Ruang Generasi Muda)Mengagas Masyarakat Komunikatif (Perspektif Bahasa dalam Ruang Generasi Muda)
Mengagas Masyarakat Komunikatif (Perspektif Bahasa dalam Ruang Generasi Muda)prakoso bhairawa
 
Upaya Peningkatan Kompetensi Peneliti
Upaya Peningkatan Kompetensi PenelitiUpaya Peningkatan Kompetensi Peneliti
Upaya Peningkatan Kompetensi Penelitiprakoso bhairawa
 
Karakteristik Pedagang Kaki Lima Di Pasar Cibinong
Karakteristik Pedagang Kaki Lima Di Pasar CibinongKarakteristik Pedagang Kaki Lima Di Pasar Cibinong
Karakteristik Pedagang Kaki Lima Di Pasar Cibinongprakoso bhairawa
 
Presentasi PENDIDIKAN BUDAYA DAN KARAKTER BANGSA
Presentasi PENDIDIKAN BUDAYA DAN KARAKTER BANGSAPresentasi PENDIDIKAN BUDAYA DAN KARAKTER BANGSA
Presentasi PENDIDIKAN BUDAYA DAN KARAKTER BANGSANASuprawoto Sunardjo
 
Presentasi pendidikan karakter bangsa
Presentasi pendidikan karakter bangsa Presentasi pendidikan karakter bangsa
Presentasi pendidikan karakter bangsa Ria Mey
 
Komunikasi berkesan
Komunikasi berkesanKomunikasi berkesan
Komunikasi berkesanlindasobri
 

Viewers also liked (9)

My new title
My new titleMy new title
My new title
 
Enterprise 2.0 With Plone
Enterprise 2.0 With PloneEnterprise 2.0 With Plone
Enterprise 2.0 With Plone
 
My new title
My new titleMy new title
My new title
 
Mengagas Masyarakat Komunikatif (Perspektif Bahasa dalam Ruang Generasi Muda)
Mengagas Masyarakat Komunikatif (Perspektif Bahasa dalam Ruang Generasi Muda)Mengagas Masyarakat Komunikatif (Perspektif Bahasa dalam Ruang Generasi Muda)
Mengagas Masyarakat Komunikatif (Perspektif Bahasa dalam Ruang Generasi Muda)
 
Upaya Peningkatan Kompetensi Peneliti
Upaya Peningkatan Kompetensi PenelitiUpaya Peningkatan Kompetensi Peneliti
Upaya Peningkatan Kompetensi Peneliti
 
Karakteristik Pedagang Kaki Lima Di Pasar Cibinong
Karakteristik Pedagang Kaki Lima Di Pasar CibinongKarakteristik Pedagang Kaki Lima Di Pasar Cibinong
Karakteristik Pedagang Kaki Lima Di Pasar Cibinong
 
Presentasi PENDIDIKAN BUDAYA DAN KARAKTER BANGSA
Presentasi PENDIDIKAN BUDAYA DAN KARAKTER BANGSAPresentasi PENDIDIKAN BUDAYA DAN KARAKTER BANGSA
Presentasi PENDIDIKAN BUDAYA DAN KARAKTER BANGSA
 
Presentasi pendidikan karakter bangsa
Presentasi pendidikan karakter bangsa Presentasi pendidikan karakter bangsa
Presentasi pendidikan karakter bangsa
 
Komunikasi berkesan
Komunikasi berkesanKomunikasi berkesan
Komunikasi berkesan
 

Similar to Chen's second test slides again

Professional project writing
Professional project writingProfessional project writing
Professional project writingjkmaster
 
Software Development Standard Operating Procedure
Software Development Standard Operating Procedure Software Development Standard Operating Procedure
Software Development Standard Operating Procedure rupeshchanchal
 
CSCI-383 Lecture 5-6-7: Object-Oriented Design
CSCI-383 Lecture 5-6-7: Object-Oriented DesignCSCI-383 Lecture 5-6-7: Object-Oriented Design
CSCI-383 Lecture 5-6-7: Object-Oriented DesignJI Ruan
 
Software design.edited (1)
Software design.edited (1)Software design.edited (1)
Software design.edited (1)FarjanaAhmed3
 
Agile Methodologies And Extreme Programming
Agile Methodologies And Extreme ProgrammingAgile Methodologies And Extreme Programming
Agile Methodologies And Extreme ProgrammingUtkarsh Khare
 
Agile Methodologies And Extreme Programming - Svetlin Nakov
Agile Methodologies And Extreme Programming - Svetlin NakovAgile Methodologies And Extreme Programming - Svetlin Nakov
Agile Methodologies And Extreme Programming - Svetlin NakovSvetlin Nakov
 
Pat Farrell, Migrating Legacy Documentation to XML and DITA
Pat Farrell, Migrating Legacy Documentation to XML and DITAPat Farrell, Migrating Legacy Documentation to XML and DITA
Pat Farrell, Migrating Legacy Documentation to XML and DITAfarrelldoc
 
Basics of-software-development
Basics of-software-developmentBasics of-software-development
Basics of-software-developmentlukaramishvili
 
How to run an Enterprise PHP Shop
How to run an Enterprise PHP ShopHow to run an Enterprise PHP Shop
How to run an Enterprise PHP ShopJim Plush
 
A Lap Around Visual Studio 2010
A Lap Around Visual Studio 2010A Lap Around Visual Studio 2010
A Lap Around Visual Studio 2010adrian8three
 
Notes on software engineering
Notes on software engineeringNotes on software engineering
Notes on software engineeringErtan Deniz
 
Periodic Table of Agile Principles and Practices
Periodic Table of Agile Principles and PracticesPeriodic Table of Agile Principles and Practices
Periodic Table of Agile Principles and PracticesJérôme Kehrli
 
Practices of agile developers
Practices of agile developersPractices of agile developers
Practices of agile developersDUONG Trong Tan
 
coding is the .pptx
coding is the                      .pptxcoding is the                      .pptx
coding is the .pptxlaxmisorna12
 
CucumberSeleniumWD
CucumberSeleniumWDCucumberSeleniumWD
CucumberSeleniumWDVikas Sarin
 
DevOps interview questions and answers
DevOps interview questions and answersDevOps interview questions and answers
DevOps interview questions and answersHopeTutors1
 

Similar to Chen's second test slides again (20)

Professional project writing
Professional project writingProfessional project writing
Professional project writing
 
Software Development Standard Operating Procedure
Software Development Standard Operating Procedure Software Development Standard Operating Procedure
Software Development Standard Operating Procedure
 
CSCI-383 Lecture 5-6-7: Object-Oriented Design
CSCI-383 Lecture 5-6-7: Object-Oriented DesignCSCI-383 Lecture 5-6-7: Object-Oriented Design
CSCI-383 Lecture 5-6-7: Object-Oriented Design
 
Software design.edited (1)
Software design.edited (1)Software design.edited (1)
Software design.edited (1)
 
Agile Methodologies And Extreme Programming
Agile Methodologies And Extreme ProgrammingAgile Methodologies And Extreme Programming
Agile Methodologies And Extreme Programming
 
Agile presentation
Agile presentationAgile presentation
Agile presentation
 
Agile Methodologies And Extreme Programming - Svetlin Nakov
Agile Methodologies And Extreme Programming - Svetlin NakovAgile Methodologies And Extreme Programming - Svetlin Nakov
Agile Methodologies And Extreme Programming - Svetlin Nakov
 
The Modern Software Architect
The Modern Software ArchitectThe Modern Software Architect
The Modern Software Architect
 
Pat Farrell, Migrating Legacy Documentation to XML and DITA
Pat Farrell, Migrating Legacy Documentation to XML and DITAPat Farrell, Migrating Legacy Documentation to XML and DITA
Pat Farrell, Migrating Legacy Documentation to XML and DITA
 
Basics of-software-development
Basics of-software-developmentBasics of-software-development
Basics of-software-development
 
How to run an Enterprise PHP Shop
How to run an Enterprise PHP ShopHow to run an Enterprise PHP Shop
How to run an Enterprise PHP Shop
 
A Lap Around Visual Studio 2010
A Lap Around Visual Studio 2010A Lap Around Visual Studio 2010
A Lap Around Visual Studio 2010
 
Notes on software engineering
Notes on software engineeringNotes on software engineering
Notes on software engineering
 
Dreaweaver cs5
Dreaweaver cs5Dreaweaver cs5
Dreaweaver cs5
 
Periodic Table of Agile Principles and Practices
Periodic Table of Agile Principles and PracticesPeriodic Table of Agile Principles and Practices
Periodic Table of Agile Principles and Practices
 
Practices of agile developers
Practices of agile developersPractices of agile developers
Practices of agile developers
 
coding is the .pptx
coding is the                      .pptxcoding is the                      .pptx
coding is the .pptx
 
Ch05
Ch05Ch05
Ch05
 
CucumberSeleniumWD
CucumberSeleniumWDCucumberSeleniumWD
CucumberSeleniumWD
 
DevOps interview questions and answers
DevOps interview questions and answersDevOps interview questions and answers
DevOps interview questions and answers
 

More from Hima Challa

My cool new Slideshow!
My cool new Slideshow!My cool new Slideshow!
My cool new Slideshow!Hima Challa
 
test through jsp
test through jsptest through jsp
test through jspHima Challa
 
Chen's second test slides
Chen's second test slidesChen's second test slides
Chen's second test slidesHima Challa
 
My cool new Slideshow!
My cool new Slideshow!My cool new Slideshow!
My cool new Slideshow!Hima Challa
 
My cool new Slideshow!
My cool new Slideshow!My cool new Slideshow!
My cool new Slideshow!Hima Challa
 
Chen's first test slides
Chen's first test slidesChen's first test slides
Chen's first test slidesHima Challa
 
My cool new Slideshow!
My cool new Slideshow!My cool new Slideshow!
My cool new Slideshow!Hima Challa
 

More from Hima Challa (9)

My new title
My new titleMy new title
My new title
 
My cool new Slideshow!
My cool new Slideshow!My cool new Slideshow!
My cool new Slideshow!
 
test through jsp
test through jsptest through jsp
test through jsp
 
Chen's second test slides
Chen's second test slidesChen's second test slides
Chen's second test slides
 
My cool new Slideshow!
My cool new Slideshow!My cool new Slideshow!
My cool new Slideshow!
 
My cool new Slideshow!
My cool new Slideshow!My cool new Slideshow!
My cool new Slideshow!
 
Chen's first test slides
Chen's first test slidesChen's first test slides
Chen's first test slides
 
Another test!
Another test!Another test!
Another test!
 
My cool new Slideshow!
My cool new Slideshow!My cool new Slideshow!
My cool new Slideshow!
 

Chen's second test slides again