Skip to aside Skip to content Skip to footer

tasks: A title for the task or a problem you are trying to solve

*---START GUIDANCE (REMOVE THIS SECTION FROM YOUR TASK PAGE)---*

**The following should be the approach taken when writing or reviewing RSQKit task pages:

   - The reader should clearly understand why the topic matters and why this task is important for research software quality.
   - Be accurate and ensure the content is factually correct and reflects current good practices on research software.
   - Provide a good enough level of content so that if it's the only resource read:
      - It gives the correct impression.
      - Readers can apply the information correctly.
      - If sufficient, gives a conceptual overview and then point to existing high quality material. 
   - Motivate further learning by providing links. 
     - Prefer linking to high-quality external documentation, standards, training materials, or community guidance rather than duplicating their content.
     - Aim for the page to stand on its own as a “good enough” introduction to the topic, even when external links are not followed.
   - Overall, a reader should be able to leave the page with a correct understanding of the task and how to approach it.

**The format of the task pages are sets of headings:

Task 
   - The task or sub-task description e.g., "Why is it important to have a good README file?" and a further sub-task might be, "What key sections should a README include?"
   - This section may also briefly state what the page aims to provide (e.g. overview, practical guidance, and pointers to further resources).
Description 
   - A short description of what the task or problem is about and why it matters.
Considerations 
   - Benefits, audience, choices, characteristics of solutions, key insights, etc; things to keep in mind when thinking about this task. 
   - You could use a bulleted list for brevity.
Solutions
  - Steps and aspects of undertaking the task that takes into account the considerations. 
  - You could use a bulleted list for brevity.
  - Where appropriate, clearly indicate which parts are conceptual guidance and which are actionable steps.

This structure (task-description-considerations-solutions) should be repeated if the overall task breaks down into distinct sub-tasks.

**Add any missing tools into the _data/tool_and_resource_list.yml file

  - When referring to a tool on the page use the tool format, e.g. <a
                    tabindex="0"
                    class="tool"
                    aria-description="Distributed version control system designed to handle everything from small to very large projects with speed and efficiency"
                    data-bs-toggle="popover"
                    data-bs-placement="bottom"
                    data-bs-trigger="focus"
                    data-bs-content="<h5>Git</h5><div class='mb-2'>Distributed version control system designed to handle everything from small to very large projects with speed and efficiency</div><a href='https://git-scm.com/' target='_blank' rel='noopener' class='mt-2 me-2'><span class='badge bg-dark text-white hover-primary'><i class='fa-solid fa-link me-2'></i>Website</span></a>"
                    data-bs-template="<div class='popover popover-tool' role='tooltip'><div class='popover-arrow'></div><h3 class='popover-header'></h3><div class='popover-body'></div></div>"
                    data-bs-html="true"
                    ><i class="fa-solid fa-wrench fa-sm me-2"></i>Git</a>. 
  - Only reference tools and resources that are relevant and add clear value for the task being described (err on the side of referencing a tool/resource rather than not).

**Read existing pages to get inspiration

Read some of the existing task pages on RSQKit - https://everse.software/RSQKit/tasks and copy the approach of those you like and ideally align with the above.

**All Markdown comments and page metadata comments can be removed before making a pull request.

The RSQKit Editorial Board applies these principles when reviewing task pages - following them will help ensure consistency and quality across the toolkit.

**Organising Links and Resources in Task pages

When creating or updating task pages in RSQKit, organise links and resources clearly and consistently so that users can easily find and understand supporting materials. Task pages may include the following types of resources:
- Relevant internal pages, referenced via the “relevant pages” section added through frontmatter metadata and also linked directly within the page text.
- Training materials, currently sourced only from TeSS and discovered via keywords.
- External resources (such as articles, websites, and books) that are not training materials, which are presently included as inline links but not collected in a dedicated section.
- Tools, which are marked up using the tools tag and listed in a separate section.

**Adding a Further Reading Section

Task pages can include a dedicated Further Reading section to collect and highlight relevant external resources in a single location. The section should:
- Include externally maintained resources that provide additional information, guidance, standards, tools, or best practices related to the task.
- Allow resources to be added manually, regardless of whether they are referenced elsewhere on the page.

All resources included in the Further Reading section should be curated and accompanied by a concise description that includes:
- The intended audience, where relevant (e.g. beginners, practitioners, managers, or specialists).
- A brief explanation of the resource and its relevance to the topic.
- A direct and stable link to the resource.

Providing this context helps users identify the resources most relevant to their needs and level of expertise, supporting both general audiences and more specialised user groups.

*---END GUIDANCE---*

Task (or sub-task)

Description

Considerations

Solutions

Further Reading

Training

EVERSE TeSS search results: