Software Documentation - Githubissues

secure-software-engineering / rose

Research Tool for Online Social Environments

GNU General Public License v3.0

7 stars 8 forks source link

Software Documentation #295

Open apoller opened 7 years ago

apoller commented 7 years ago

We need to start working on a documentation we can add to our Github pages. I think we basically have three audiences:

Regular users/study participants (U)
Researchers using ROSE for their study (R)
Developers, tech guys (D)

Thinks that come into my mind that need to be described are the following.

For developers/OSS/contributors community

[ ] Pattern creation: pattern structure, howto create pattern (D) (#299)
[ ] Build from clean system: installation of necessary components, build process, reference system, e.g. Ubuntu 16.04 LTS (D) (#298)
[ ] Repository structure: files, signing, format (D) (#300)
[ ] Basic software architecture, modules, data exchange between modules, source code folder structure, used components and packages (D)

For researchers and users

[ ] ROSE infrastructure: files, repository, web browser extension (R) ( #301)
[ ] Study setup: overview, options in study creator, privacy, configuration file, rose infrastructure (repository, plugin, researcher as data recipient) (R) (#302)
[ ] ROSE export file format (D, R)
[ ] User interface (U, R)

eppfel commented 7 years ago

We definitely have to prioritize these...

And a lot of this is already there:

Build: Readme.md
Repo (besides signing): /docs
Pattern: /docs
Study setup: the parameters are explained in the study creator. we can copy that
User interface: Shouldn't this be self-explanatory?