Documentation

[sbrunswi]

1. Platform documentation

1.1. Platform overview

• App
• IronHub
• BigQuery
• Firebase
  (Copy text from PP report)

1.2. Users

• Participant
• Admin

1.3. Key concepts

• Hack
• Cohort
• Submission
• Workspace

1.4. Key features of hacks

• Registration
• Pages
  • Overview page
  • Task
  • Rules
  • Submissions
  • Results
  • Forum
  • Tutorials
  • Calendar
• Notebook viewer
• Surveys

1.5 Admin features

1. Setting up a hack
2. Registration configuration
3. Task and Rule Set-up
4. Cohort sampling
5. Submission creation
6. Result display
7. Monitoring

[sbrunswi]

@charrismatic - we should add something along those lines (This comes from an older NSF report)

Our technological developments make a contribution to a new methodological focus among scholars in the principle discipline: Large-scale online experiments. (K. J. Boudreau & Lakhani, 2015; Kevin J. Boudreau et al., 2017). The technological advancements achieved and document in the final research phase make an impact on this development. Other experimental platforms (O-tree, volunteer science etc) specifically designed for researchers typically do not allow the focus on programming tasks like data science. Contributions are primarily focused on simple contributions/artifacts (e.g. choices, votes, etc.). In our case, participants tackle data science tasks using a cloud-based editor and the platform allows scholars to track granular user interactions. The task setting is comparable to commercial platforms like Kaggle.com, a Google product, with the benefit our technological platform allows scientists to realize experimental treatments. They can also trace each behavioral interaction on the platform. The design and implementation of the IronHacks paltform makes a technical contribution to the field. The new platform offers new opportunities for complex real-time evaluation of the applications, and user behaviors (e.g. likes, etc.), which is essential to study the effect of new means for transparency design. There is a unique opportunity to use our platform in the future: it can be expanded to other settings and innovative tasks.

[sbrunswi]

@charrismatic - we need to emphasize what this platform "traces" compared to a Kaggle for example...I can work on a general section but we should also write down the data that we collect (helps with the structure of the data repo as well).

[sbrunswi]

@charrismatic I can close this for now, and open a new issue to update the documentation with a focus on experimentation! This would be my task then and you would review you what I write.

[charrismatic]

What page in the docs should that text go on?

[sbrunswi]

Should go here: https://github.com/ironhacks/docs/blob/master/docs/index.md I do a draft!

[sbrunswi]

@charrismatic I reviewed/updated the index file and wrote some additional text for it. 04727e3
This introduces the research and the experimental settings in the overview. Could you please address the cohorts more in the admin part of the documentation.