Code Monkey home page Code Monkey logo

documentation's Introduction

Documentation for DINA-Web

This is the documentation project for the DINA-Web collection management system.

View Documentation

See documentation practices on the Redmine wiki. Documentation is maintained mainly by using the wiki. To clone the wiki repo, you do:

$ git clone https://github.com/DINA-Web/documentation.wiki.git

This documentation repository will mostly contain images and other attachements to the documentation.

documentation's People

Contributors

antonoberg avatar jmenglund avatar mikkohei13 avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Forkers

mikkohei13

documentation's Issues

Proposed changes to Home.md

@kcranston and I would like to propose some changes to the documentation wiki.
The main idea is to bring the different modules in the index to facilitate the finding of specific pieces.

Please see the proposed changes below regarding the Home.md file of the wiki. If we agree, I will change it directly in the wiki (and the links to other wiki pages will work).


Index of DINA-Web system documentation:

Overview

  • [[Overview]] of the goals, guidelines, principles and decisions.

User manual

  • [[User manual]] for collection managers.

Modules

Accounts management

Collection management

Taxonomy management

  • [[ Taxonomy Management ]] documentation

Developers documentation

  • Guidelines
  • [[ Development manual ]] for developers
  • [[ Technology-overview ]]
  • [[ Docker Practices ]]

Private Space

Login required

Tasks

Services

This contains all services related to DINA. Please see the [[User Manual]] for links only to regular user interface (requires login).

Parts of the manual are work-in-progress or still awaiting final decisions (TBD).
Manual will be written in English. (Possible translations of stabilized documentation will be discussed later.)

Non-functional requirements

It would be very useful to identify the top non-functional requirements for the DINA system.
These requirements should guide general direction and influence architectural and design decisions. As a multi-modules, multi-institutions system, I would suggest the following list:

  • Maintainability
  • Testability
  • Documentation (code and user documentation)
  • Interoperability (e.g. JSON-API)
  • Extensibility

It doesn't mean other non-functional requirements are not important but more that in case of conflict, the requirement from the list above should be prioritized. e.g. Maintainability vs Performance

How many DINA systems / modules per institution?

I have some high-level questions about the DINA system (triggered by discussion of the taxonomy module, but pertain to development as a whole). I assume that:

  • DINA consists of multiple modules (collection, taxonomy, etc)
  • An institution (e.g. Naturhistoriska riksmuseet, Agriculture and Agri-Food Canada) can have multiple collections (e.g. mammals, fungi, plants)

Will a single institution install:

  1. A single DINA system with one instance of each module
  2. A single DINA system with one or more instance of each module (e.g. one taxonomy module and multiple collection modules, or one collection module with multiple taxonomy modules)
  3. Multiple DINA systems (one for each collection)

Will there be a single user interface for each institution or each DINA installation or each collection?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.