{"id":25138457,"url":"https://github.com/fair2-for-research-software/documentation","last_synced_at":"2026-01-28T00:08:29.203Z","repository":{"id":240672569,"uuid":"803284923","full_name":"FAIR2-for-research-software/Documentation","owner":"FAIR2-for-research-software","description":"This is a course on software documentation for researchers developed by the Research Software Engineering team and IT Services at the University of Sheffield.","archived":false,"fork":false,"pushed_at":"2025-04-01T00:31:44.000Z","size":4283,"stargazers_count":1,"open_issues_count":3,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-01T01:29:43.114Z","etag":null,"topics":["documentation","fair4rs","reproducible-research","research-software-engineering","rse","software-engineering"],"latest_commit_sha":null,"homepage":"https://fair2-for-research-software.github.io/Documentation/","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/FAIR2-for-research-software.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":"CITATION.cff","codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-05-20T12:37:38.000Z","updated_at":"2025-03-06T12:10:25.000Z","dependencies_parsed_at":"2024-05-20T13:53:41.520Z","dependency_job_id":"c84f5e0d-5b79-4f5b-b976-f2dcd2ba3c4a","html_url":"https://github.com/FAIR2-for-research-software/Documentation","commit_stats":null,"previous_names":["joe-heffer-shef/fair4rs-documentation","fair2-for-research-software/documentation"],"tags_count":0,"template":false,"template_full_name":"carpentries/workbench-template-md","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FAIR2-for-research-software%2FDocumentation","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FAIR2-for-research-software%2FDocumentation/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FAIR2-for-research-software%2FDocumentation/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FAIR2-for-research-software%2FDocumentation/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/FAIR2-for-research-software","download_url":"https://codeload.github.com/FAIR2-for-research-software/Documentation/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246927841,"owners_count":20856198,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation","fair4rs","reproducible-research","research-software-engineering","rse","software-engineering"],"created_at":"2025-02-08T17:16:38.730Z","updated_at":"2026-01-28T00:08:29.197Z","avatar_url":"https://github.com/FAIR2-for-research-software.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# FAIR\u003csup\u003e2\u003c/sup\u003e Documentation\n\n[![01 Build and Deploy\nSite](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)\n\n# Research Software Documentation\n\nThis repository contains a [training module on documenting research\nsoftware](https://fair2-for-research-software.github.io/Documentation/) that is part of the [training provision for\nresearch computing](https://sites.google.com/sheffield.ac.uk/research-training/) at the University of Sheffield and\ndeveloped as part of the [FAIR\u003csup\u003e2\u003c/sup\u003e for research software](https://rse.shef.ac.uk/training/fair4rs/) course.\n\n## Course description\n\nThis course will introduce you to the different ways we can provide guidance to future users and maintainers of our\ncode. These coding best practices range from the very simple, such as leaving a few handy notes, to the complex,\ngenerating a reference website that includes tutorials and a detailed reference. The right approach for your projects\nwill probably be a blend of these, and depends on the context and your audience.\n\n## Course overview\n\nThis course introduces the different ways to provide other researchers with useful documentation for your software.\n\n- Writing informative README files\n  - Writing installation instructions\n  - Writing usage instructions\n  - Writing contribution guidelines\n- Improving code readability\n  - Doc-strings for functions\n  - Usage examples for functions\n  - Type hints\n- Publishing documentation websites\n- Command line interfaces with usage instructions\n\nThere is information about publishing a software package and providing metadata and citation details in Modules 6 and 7\nof this course.\n\n# Contact us\n\nPlease contact [Research \u0026 Innovation IT](https://sheffield.ac.uk/it-services/research) or [Research Software\nEngineering](https://rse.shef.ac.uk/) at the University of Sheffield.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffair2-for-research-software%2Fdocumentation","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffair2-for-research-software%2Fdocumentation","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffair2-for-research-software%2Fdocumentation/lists"}