Note: If your software is unique (not Wordpress, Omeka, etc.), create a .zip or .tar file containing source code and a readme file explaining software requirements (e.g. OS, Apache, MYSQL, PHP, Python versions) and building instructions. This zip or tar file can supplement your thesis or dissertation deposit.
If you want to archive your website beyond merely creating a WARC file, for fuller reproducibility, here is a list of the most common platforms and associated unique files and directories that are suggested to archive.
Wordpress:
Omeka:
Scalar:
HTML:
Mobile (tablets and phones):
Software Standards:
Successful archiving of software and data is dependent upon good data management practices. Here are a few things to remember:
Every project should have its own root directory
Separate folders for data, images, and scripts
Comment the code. Include a readme with (a file manifest and codebook), installation instructions with requirements, dependencies, operating instructions, copyright and licensing info, contact info, known bugs, troubleshooting, acknowledgments, and news. A File Manifest, a simple listing of files and directories.
Include a Codebook with the following info:
Variable Names - the short column header in the data. No spaces, no symbols, maybe some numbers
Variable Labels - the full description of a variable, clarifying the variable name and allowable value ranges.
Missing Data - How do you know if the data is omitted vs missing? Different standards are NA, . , #N/A, -88, -99, -999. Be consistent.
Date Variables - standard date-time formats - ymd_hms 2019-11-05 13:15:00 UTC or YYYYMMDD. Be consistent.
See: http://www.medicine.mcgill.ca/epidemiology/joseph/pbelisle/CodebookCookbook.html and https://github.com/DataCurationNetwork/data-primers
Copyright considerations: If hosting or distributing, ensure that you ‘own’ or have permission (creative commons) to use others’ work.
Do not encrypt or compress files.