Documentation Plan

[qwu102]

Summary of Materials

Given Information

• Prof. Pearson's guidelines email (convert to a PDF)
• Prof. Pearson's instructions about IPUMS on Word (convert to PDF)
• Team Contract

Our Work: General

• Literature Review notes
• Causal diagrams
• Hypothesis workshop

Issues

• Stream of Consciousness
• General/report tasks
• Literature Review
• Data-related tasks
• Feedback
• Documentation Plan

Our Work: Data

• .dat and .do files downloaded from IPUMS and uploaded to OneDrive
• README file for accessing data

Our Work: Presentation & Report

• Dec. 08 Presentation PowerPoint
• Dec. 08 Presentation PDF
• Final Report Draft on Word
• Final Report on Overleaf (provide link and PDF)

[qwu102]

Documentation Plan: Timeline

Things we have access to/that are completed right now

We can make sure these are in our documentation by the end of this weekend (Sunday, Dec. 10).

• Prof. Pearson's guidelines email
• Prof. Pearson's Word doc on IPUMS
• Team Contract
• Literature Review notes
• Causal diagrams
• Hypothesis workshop
• Issues (links)
• Downloaded .dat and .do files
• README file for data
• Dec. 08 Presentation PowerPoint and PDF

Monday, Dec. 11 to Friday, Dec. 15

• Update issues (links, descriptions, posts)
• Upload completed .do files (after writing and updating all the codes for our analysis)
• Finish README file
• Upload at least a draft of or link to final report

Saturday, Dec. 16 to Sunday, Dec. 17

• Double check documentation and make sure it has everything we worked on within a singple page

[kbuzard]

@ecn310/migration You don't actually need all this--the documentation that goes with the final submission is going to be easier than you think!

You don't need anything that is strictly process related, like the work you did to generate your hypothesis. The final hypothesis and the theory supporting it will be in the report directly, and that's all you need.

I think everything you need is summarized on slide 10 from class yesterday.

In terms of what you have above, you're going to need:

• "Prof. Pearson's instructions about IPUMS on Word (convert to PDF)"--if his instructions were complete, and they are exactly what you did to download your data, then you can include them in your documentation and attribute them to Professor Pearson. If you did anything different, then modify the instructions so they match what you did.
• both items under "Our Work: Data"
• The final report: download the .tex and PDF from Overleaf and put them with the rest of your files; you don't need to also include your draft.

You will likely pull from the rest of what you have to write the replication package README

This plan doesn't tell me where all your files are going to be, though. It also doesn't talk about making sure all the .do files are commented, or putting together the two READMEs (one long one with the full set of instructions for replicating the whole process; a short one that gives a brief overview of where everything is like at the bottom of this page.

• It also doesn't say where the long set of instructions will be stored. Will they fit in a data appendix? Or will you just have a short statement in the data appendix or a footnote in the data section to point to where the instructions can be found?
• Who will you get to test your documentation to make sure an outsider can access and replicate everything?

For a pretty comprehensive plan, see what the Accidents team did here as an example.