https://github.com/fair2-for-research-software/documentation

This is a course on software documentation for researchers developed by the Research Software Engineering team and IT Services at the University of Sheffield.
https://github.com/fair2-for-research-software/documentation

documentation fair4rs reproducible-research research-software-engineering rse software-engineering

Last synced: 5 days ago
JSON representation

This is a course on software documentation for researchers developed by the Research Software Engineering team and IT Services at the University of Sheffield.

• Host: GitHub
• URL: https://github.com/fair2-for-research-software/documentation
• Owner: FAIR2-for-research-software
• License: other
• Created: 2024-05-20T12:37:38.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2025-02-05T11:02:00.000Z (8 days ago)
• Last Synced: 2025-02-05T12:18:49.825Z (8 days ago)
• Topics: documentation, fair4rs, reproducible-research, research-software-engineering, rse, software-engineering
• Homepage: https://fair2-for-research-software.github.io/Documentation/
• Size: 4.61 MB
• Stars: 1
• Watchers: 1
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md
  • Citation: CITATION.cff
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
[![01 Build and Deploy Site](https://github.com/Joe-Heffer-Shef/FAIR4RS-Documentation/actions/workflows/sandpaper-main.yaml/badge.svg)](https://github.com/Joe-Heffer-Shef/FAIR4RS-Documentation/actions/workflows/sandpaper-main.yaml)

# Research Software Documentation

This repository contains a course on documenting research software that is part of the [training provision for research computing](https://sites.google.com/sheffield.ac.uk/research-training/) at the University of Sheffield.

## Course description

This course will introduce you to the different ways we can provide guidance to future users and maintainers of our code. These coding best practices range from the very simple, such as leaving a few handy notes, to the complex, generating a reference website that includes tutorials and a detailed reference. The right approach for your projects will probably be a blend of these, and depends on the context and your audience.

## Course overview

This course introduces the different ways to provide other researchers with useful documentation for your software.

- Writing informative README files

  * Writing installation instructions

  * Writing usage instructions

  * Writing contribution guidelines

- Improving code readability

  * Doc-strings for functions

  * Usage examples for functions

  * Type hints

- Publishing documentation websites

- Command line interfaces with usage instructions

There is information about publishing a software package and providing metadata and citation details in Modules 6 and 7 of this course.

# Contact us

Please contact [Research & Innovation IT](https://sheffield.ac.uk/it-services/research) or [Research Software Engineering](https://rse.shef.ac.uk/) at the University of Sheffield.