Skip to content
This repository has been archived by the owner on Apr 29, 2022. It is now read-only.

Documentation Guidelines

Clay McLeod edited this page Jan 3, 2018 · 1 revision

Introduction

The St. Jude Cloud 'technical documentation' is a set of documents that advise users of SJCloud on how to interact with the site. Each of the tools exposed at https://platform.stjude.cloud/tools has detailed user guide describing briefly what each pipeline does, then giving detailed instruction on how operation of the tool is conducted and how results can be interpreted. It is crucially important that the documentation be comprehensive and accessible to all different audiences for your tool to be adopted as an official offering of SJCloud.

Writing Documentation

TODO.