|
1 |
| -Australian BioCommons Documentation Guidelines |
| 1 | +[tool / workflow name] |
2 | 2 | ==============
|
| 3 | +Australian BioCommons Documentation Guidelines |
| 4 | + |
| 5 | +``` |
| 6 | +################################################################################### |
| 7 | +### Delete this section when the first version of the documentation is complete ### |
| 8 | +################################################################################### |
| 9 | +
|
| 10 | +You can make use of this template repository as a base template for a new GitHub repository. |
| 11 | +
|
| 12 | +General information about the guidelines |
| 13 | +
|
| 14 | +- This **template** repository contains a set of guidelines for documenting bioinformatics tools and workflows. |
| 15 | +- The initial version uploaded to GitHub was informed by current documentation practices and structures used in the GitHub community. |
| 16 | +- These guidelines will be further developed as needed to meet the requirements of the Australian BioCommons community. |
| 17 | +``` |
| 18 | + |
| 19 | +--- |
| 20 | + |
| 21 | +# General recommendations for using [tool / workflow name] |
| 22 | + |
| 23 | +``` |
| 24 | +Recommendations on using the workflow: for example, based on data set size, infrastructure suitability. |
| 25 | +``` |
| 26 | + |
| 27 | +--- |
3 | 28 |
|
4 |
| -This repository contains a set of guidelines for bioinformatics tools and workflows. |
| 29 | +# Resources available here |
5 | 30 |
|
6 |
| -The initial version uploaded to GitHub was informed by current documentation practices and structures used in the GitHub community. |
| 31 | +This repository contains structured documentation for [workflow name], including links to existing repositories and community resources, as well as a description of the optimisations achieved on the following compute systems: |
7 | 32 |
|
8 |
| -These guidelines will be further developed as needed to meet the requirements of the Australian BioCommons community. |
| 33 | +- [system name](infrastructure_optimisation.md) |
| 34 | +- ... |
9 | 35 |
|
10 |
| -See the following links to access the guideline templates: |
| 36 | +--- |
11 | 37 |
|
12 |
| -1. [tools](docs/tools.md) |
13 |
| -2. [workflows](docs/workflows.md) |
14 |
| -3. [infrastructure optimisation](docs/infrastructure_optimisation.md) |
|
0 commit comments