Software Requirement Specification Document
Edit me
Introduction
Purpose
The purpose of this document is to specify the requirement of the WorkshopSceduler application.
Intended Audience
- Newcastle University Research Software Engineering Team
- Student Interns
- End users
Intended Use
Scope
The purpose of this software is to make it easier to generate a schedule in HTML format that can be included the website created for a Carpentries workshop.
Definitions and Acronyms
- Carpentries refers to The Carpentries organisation
Overall Description
User Needs
Assumptions and Dependencies
The HTML output generated by this software is intended for inclusion into the schedule.html file which is part of the Carpentries Workshop GitHub Template. Refer to the linked repository for more information on using the template to create a workshop website.
System Features and Requirements
Functional Requirements
- Read data from a CSV file
- Alternative GUI input form
- Display entries in a tabular form (like a spreadsheet)
- Allow for re-ordering entries by moving a row up or down
- When a row is moved up or down the time entries should be adjusted automatically based on the time given for the entry
- Allow export of entries to html format for inclusion in the workshop website. The html should not be embedded in a complete HTML page but only formatted as an HTML table.
- Provide configuration capability to colour break entries (default green)