Documentation Plan

[abigailmondin]

Task	Target Date	Completed Date	Assignee	Notes
Begin README	Dec. 9		Sophie	Begin the excruciating documentation
Execute documentation plan	Dec. 11		Abigail
Revise documentation	Dec. 12		Abigail	Revise/fix anything with the documentation
Finalize documentation for testing	Dec. 13		Abigail	Make sure the documentation is complete and working
Documentation testing by insider	Dec. 14		Abigail	Test the documentation links
Final documentation testing by outsider	Dec. 16		Ixora	Use an outsider to test that the documentation works properly
Completed README	Dec. 17		Sophie and Abigail	Make sure the README is completed updated and working properly

[kbuzard]

@ecn310/diop Where is the actual documentation plan? As in the "List all the pieces that your project requires in a plan that says where each piece will be stored and how each piece will relate to the whole;" then a timeline of how all those tasks are going to get done and by whom?

[abigailmondin]

@kbuzard I think we must have misunderstood what you meant. I'm still not quite sure I understand what you're looking for, is the documentation plan supposed to be like the plan for putting the README together?

[kbuzard]

@kbuzard I think we must have misunderstood what you meant. I'm still not quite sure I understand what you're looking for, is the documentation plan supposed to be like the plan for putting the README together?

An important part is putting together the full set of instructions for how to replicate (including instructions for how to download the data). It's also making sure that all the files (data, code, documentation, outputs) are organized and documented (comments in the do files, for example), and what part of this are going to go into the data section of the paper, what's going into the data appendix, what is going into a high-level README for the project, where to store everything, setting permissions so that an outside person can access and run everything, and possibly more that I've forgotten.

[xorabear]

DIOP

Task	Target Date	Completed Date	Assignee	Notes
Incorporate Feedback	Dec 15		Ixora
Deliver Report to Outside reader	Dec 14		Ixora
Submit whole package	Dec. 18		Sophie	Still need to decide where to host documentation
Final proofread of report	Dec. 17		Ixora	Will use Grammarly (or the writing center)
Final proofread of documentation	Dec. 17		Ixora	Will use Grammarly (or the writing center)
Final documentation testing by outsider	Dec. 16		ixora
Edit report	Dec. 16		Sophie
Preliminary documentation testing by outsider	Dec. 15		Ixora
Documentation testing by insider	Dec. 14		Abigail
Revise report	Dec. 14		Luke
Finalize documentation for testing	Dec. 13		Abigail
Revise documentation	Dec. 12		Abigail
First draft of report	Dec. 11		Luke
Execute documentation plan	Dec. 11		Abigail
Finalize abstract / intro	Dec. 10		Sophie
Finalize discussion / conclusion	Dec. 10		Abigail
Finalize data section	Dec. 9		Luke
READ ME file	Dec.9		Sophie
Finalize analysis section	Dec. 8		Sophie
Present in class for feedback	Dec. 8	Dec 8	Whole Group
Finalize hypothesis/theory section	Dec. 7		Abigail
Finalize lit review and references	Dec. 6	Dec 7	Ixora	compiling all the literature reviews and adding references
Complete analysis	Dec. 6		Whole Group	all figures/tables need to be done

• Data Replication The data set was found via.... To gain more insights on the variables we used the commands summarize and tab1 then created graphs via Stata. Abigail has detailed descriptions under each one of her figures. Sophie created her table using the previously listed command. Luke created his figures with Overleaf and Stata.
• There's an issue with the charts, graphs, and documentation and they'll be a summary of the findings on our data.
• The modified data sets will be on GitHub and the Original data set will remain on OneDrive because it's too big to upload.
• The Data Appendix will be variables as we used them to create the figures.
• The do file changes will be more thoroughly documented through the commits section as needed.
• Readme requirements
• Everything will be located on Overleaf, and GitHub except for the original data set.
• The person looking at the documentation and our final results will have access to the GitHub project
• Abstract • Intro this would be • Lit review • (Optional) Theory / Hypothesis • Data This would explain how we got our data and how we used our data to create graphs and figures. • Results • Discussion • Conclusion Connect the whole paper and restate the argument and our results. • References / Bibliography

[kbuzard]

@ecn310/diop

This timeline you've posted above looks to me like a copy of the final submission plan without any new detail on the documentation tasks. What you've written after the timeline tells me where things will be. But it doesn't tell me how each task will get done (e.g., write the high-level readme on Github; write the download instructions; comment the do files; organize the files in the repo; put together the full set of instructions for replication, etc.), by whom, and when. For an example with the kind of detail I'm looking for, see the Accidents team's plan here.

I will make your repo public as soon as I post this.

[abigailmondin]

New Documentation Plan (based on feedback)

@xorabear @sophiehaber @ltsippel @kbuzard	Task	Target Date	Completed Date	Assignee	Notes
Write README	?		Sophie, Abigail	We need to write a high-level README, which we will do in Github
Write the download instructions	Dec. 12	Dec. 11	Abigail, Sophie	Write a step by step of how to download and access the 2016 RAND HRS dataset
Complete master do file	Dec. 13		Abigail	Finish all code needed to reproduce our results
Check do file	Dec. 14		Ixora	Run the do file to check the reproducibility of our work
Fix do file (if needed)	Dec. 14		Ixora	If needed, fix any mistakes, typos, etc. in the do file
Documentation test by insider	Dec. 14		Abigail	Test our documentation to ensure that someone else could find and open everything they would need to reproduce our work
Organize the files in the repo	Dec. 15		Ixora	Ensure that all of our files within the repo are organized and labeled effectively
Documentation test by outsider	Dec. 16		Ixora	Have an outsider test our documentation to ensure they can find and open everything they would need to reproduce our work
Fix documentation (if needed)	Dec. 16-17		Ixora	If needed, fix any and all of the mistakes in the documentation
Final documentation	Dec. 17		Ixora	Read through the documentation and double check everything looks how it should