User-oriented documentation for the Bioreactor bioinformatics analysis web server framework.
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:
- Wikipedia – Getting Started
- Mozilla Firefox User Guide
- Git – Getting Started Guide
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.