Giter VIP home page Giter VIP logo

bioreactor-docs's Introduction

Bioreactor User Documentation

User-oriented documentation for the Bioreactor bioinformatics analysis web server framework.

CS5002 Assignment #3: User Manual (Due Feb 1)

Create web pages for a user guide or manual, so that users have a "howto" resource to refer to for your project. You should submit a public link to your project’s user guide or manual. The goal of this assignment is to give assistance to people using your particular project or system. Most user guides contain both written explanations and associated images, e.g. screenshots. The language used in the guide should match to the level of the intended or typical user. Jargon should be kept to a minimum or explained thoroughly. Your pages should include an FAQ, which is helpful to address common questions or concerns of users.

Here are some model user guides that you may consider emulating:

Credits

The HTML version of the Bioreactor user manual makes use of Junil Um's markdown-toc, which in turn makes use of the Tocify jQuery plugin by Greg Franko.

The PDF version of this document was created with John MacFarlane's Pandoc document processing system.

bioreactor-docs's People

Contributors

ernstki avatar

Watchers

James Cloos avatar  avatar  avatar

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.