From c42ad140ae13ca0fac9e8cb55e41d3053c040661 Mon Sep 17 00:00:00 2001 From: alexandermendes Date: Wed, 22 Jun 2016 16:31:57 +0100 Subject: [PATCH] Update docs --- development_docs.md | 16 ++++++++++++++++ project_docs.md | 46 ++++++++++++++++++++++++++------------------- 2 files changed, 43 insertions(+), 19 deletions(-) create mode 100644 development_docs.md diff --git a/development_docs.md b/development_docs.md new file mode 100644 index 0000000..36bea48 --- /dev/null +++ b/development_docs.md @@ -0,0 +1,16 @@ +# LibCrowds Development Documentation + +The following document aims to provide a few guidelines for future development +and maintenance. + + +## External documentation + +To get an idea of how things work, the first step would be to become familiar +with the documentation for the +[libcrowds-pybossa-theme](https://github.com/LibCrowds/libcrowds-pybossa-theme), +[libcrowds-analyst](https://github.com/LibCrowds/libcrowds-analyst) and any plugins listed on the LibCrowds +[http://www.libcrowds.com/about] page. + + +... diff --git a/project_docs.md b/project_docs.md index cb2584f..41e32df 100644 --- a/project_docs.md +++ b/project_docs.md @@ -15,11 +15,21 @@ menu, which provides access to various settings and additional information regarding the project, including: - **Analysis:** A link to the results analysis application (see below). -- **Results:** View the current results, which can be useful for spot checking. -- **Statistics:** View contribution statistics. +- **Results:** To view the current results (useful for spot checking). +- **Statistics:** Contribution statistics for the project. -## Creating a new project +## Workflow + +For specific details of the workflow established for your project, please see +the documentation available for each type of project on the +[LibCrowds GitHub page](https://github.com/LibCrowds?utf8=%E2%9C%93&query=project) +(e.g. [project-convert-a-card](https://github.com/LibCrowds/project-convert-a-card)). + +Following is a general outline for all project types. + + +#### 1. Creating a new project The easiest way to create a LibCrowds project is probably to use [pybossa-github-builder](https://github.com/alexandermendes/pybossa-github-builder), @@ -28,37 +38,35 @@ a new project using this plugin are as follows: 1. Visit the [Create Project from GitHub](http://www.libcrowds.com/github/new_project) page. 2. Search for a GitHub repository. -3. Choose the import settings and create a new project. +3. Configure the import and create a new project. 4. Import some tasks. 5. Set the task redundancy. 6. Publish. -Visit the [LibCrowds GitHub page](https://github.com/LibCrowds?utf8=%E2%9C%93&query=project) -for specific instructions regarding your type of project. - Note that there are various other ways to create new projects, all of which are described in the [PyBossa documentation](http://docs.pybossa.com/en/latest/user/overview.html). -## Analysing results +#### 2. Analysing results -A separate application has been create to handle the analysis of results. The +A separate application has been created to handle the analysis of results. The analysis process is automated, as far as possible, according to the rules -defined for each category of project (which happens during the development -stage). - -Human intervention is only required for any results that cannot be analysed -automatically (e.g. those that contributed to the task all gave different answers). -A template is available for each category of project that aims to make the process -of checking answers as straightforward as possible. +defined for each category of project. Human intervention is only required for +any results that cannot be analysed automatically (e.g. different answers were +given for the task). A template is available for each category of project that +aims to make the process of checking these answers as straightforward as possible. The **Analysis** menu option, available via the project dashboard, provides a -link to this application. Next to the same link, a notification will appear when -there are results that need to be checked. A password is required to access the +link to this application. A notification will appear next to this link showing +when there are results that need to be checked. A password is required to access the application, which can be requested from a LibCrowds administrator. +Results can also be viewed via the **Results** menu option, also available via +the project dashboard. While nothing can be modified here, this view can be useful +for spot checking. + -## Project completion +#### 3. Project completion Once a project has been completed and all results analysed a CSV containing the final results can be download from the