10
Documenting the Process Documenting the Process

Documenting the Process. Presenting your work in a clear, coherent fashion… Process Documentation Outcome Documentation versus Recording and documenting

Embed Size (px)

Citation preview

Page 1: Documenting the Process. Presenting your work in a clear, coherent fashion… Process Documentation Outcome Documentation versus Recording and documenting

Documenting the ProcessDocumenting the Process

Page 2: Documenting the Process. Presenting your work in a clear, coherent fashion… Process Documentation Outcome Documentation versus Recording and documenting

Documenting the ProcessDocumenting the Process

Presenting your work in a clear, coherent fashion…

Process Documentation

OutcomeDocumentation

versus

Recording and documenting every step of the journey…

versus

Page 3: Documenting the Process. Presenting your work in a clear, coherent fashion… Process Documentation Outcome Documentation versus Recording and documenting

Why Document?Why Document?

What happened and when?– Whose idea was it?– Who can corroborate?– What research was done?– What experts were consulted?

– Documentation can be your best evidence for proving that an idea or discovery was yours and when you had the idea.

– Documentation is the best way to communicate your ideas and thought processes to others.

“If it isn't written down, it didn't happen.“

Page 4: Documenting the Process. Presenting your work in a clear, coherent fashion… Process Documentation Outcome Documentation versus Recording and documenting

Process Versus Outcome DocumentationProcess Versus Outcome Documentation

Process Documentation

Engineering Notebook– A book in which an engineer will

formally document, in chronological order, all work that is associated with a specific design project.

every idea…

every research link…

every interview…

…dates

…times

…places

Page 5: Documenting the Process. Presenting your work in a clear, coherent fashion… Process Documentation Outcome Documentation versus Recording and documenting

Process versus Outcome DocumentationProcess versus Outcome Documentation

Process Documentation

Digital Files– Relevant digital files should inserted into the

engineering notebook.– All digital files should be stored in a secure and

organized location. – Digital files should be regularly backed up.

“Everything Else”– Everything else that has been printed, copied, or is

a hard copy should go into an organized three ring binder.

– Class notes and material not specific to your EDD project can also be organized in the three ring binder.

every idea…

every research link…

every interview…

…dates

…times

…places

Page 6: Documenting the Process. Presenting your work in a clear, coherent fashion… Process Documentation Outcome Documentation versus Recording and documenting

Process versus Outcome DocumentationProcess versus Outcome Documentation

Outcome Documentation

• Mostly derived from the work and documentation of the process documentation

• The format and components of the outcome documentation are dependent on the audience– Your peers?

– A panel of reviewers?

– Investors?

– Trade journal article?

– Patent office?

– Customers?

“Tell me how you got from A to Z, how you made decisions along the way, and what you have learned…” Microsoft Clipart

Page 7: Documenting the Process. Presenting your work in a clear, coherent fashion… Process Documentation Outcome Documentation versus Recording and documenting

Process versus Outcome DocumentationProcess versus Outcome Documentation

Outcome Documentation

Common elements of most outcome documentation– The problem and the solution – Sketches and technical drawings– Models / prototypes– Research

• Specific to the problem and design• Market research

– Test procedures and data– Expert input

Page 8: Documenting the Process. Presenting your work in a clear, coherent fashion… Process Documentation Outcome Documentation versus Recording and documenting

Process versus Outcome DocumentationProcess versus Outcome Documentation

Outcome Documentation

Common forms of outcome documentation– Project portfolio– Trade journal article– Website– Trade show– Formal/juried presentation– Three panel display– Research paper

Note: Combinations of the above and others also are used.

Microsoft Clipart

Page 9: Documenting the Process. Presenting your work in a clear, coherent fashion… Process Documentation Outcome Documentation versus Recording and documenting

Documenting the ProcessDocumenting the Process

• Why Document?• Process versus Outcome Documentation

Questions or Comments?Questions or Comments?

Page 10: Documenting the Process. Presenting your work in a clear, coherent fashion… Process Documentation Outcome Documentation versus Recording and documenting

Image ResourcesImage Resources

Microsoft, Inc. (n.d.). Clip art. Retrieved from http://office.microsoft.com/en-us/clipart/default.aspx

iStockphoto. Retrieved from http://www.istockphoto.com/index.php