SWORDv2 Project Plan – Workplans

This is the second in a series of blog posts that is outlining the project plan for the SWORDv2 project.  This post will describe the work packages that will be undertaken over the next 6 months to complete the project.

Work package 1: Compile use cases

  • The project will work with the SONEX group to gather, document, and publicise relevant use cases that fit with the overarching principles of SWORD v2. These use cases will be used to ensure that the SWORD v2 standard meets the requirements of the repository community.  In addition the community manager will ensure that the repository manager community is made aware of the project, and is encouraged to participate in the collection use cases.

Work package 2: Analysis of white paper

  • As a concluding part to the SWORD 3 project, the Technical Lead wrote a white paper that outlined the potential requirements of the SWORD v2 standard. This white paper was given wide publicity at the Open Repositories 2010 conference and was placed online on the JISCPress site ( for comment by the community.The feedback received from the community needs to be analysed, and once combined with the use cases from the SONEX group it will be written-up to create a document that will define the use cases, requirements, and outputs of the SWORD v2 project. The document will be used to describe to the community what the standard will do and why it will do it, and will give rise to the standard itself in work package 4.

Work package 3: Initial community formation

  • While the analysis of the white paper is being undertaken the Community Manager will need to perform work to start to form an initial community around the SWORD v2 work. This first phase of community building will be centered around publicity of the project including a project web site and blog (to supplement the current site), an elevator pitch to explain the aims of the project to the community, and the creation of an effective communications channel to allow dissemination, discussion and feedback to easily take place.A technical advisory panel will be created that consists of project staff members, and developers and repository managers from the worldwide repository community. They will come from a cross section the different repository platforms and user types. Whilst all aspects of the project will be open for comment by any interested party, the technical advisory panel will be consulted closely at all times to ensure the project is meeting the requirements of the repository community.

Work package 4: Creation of prototype SWORD v2 specification

  • Following the analysis of the white paper, the creation of the report and the formation of the initial community, a prototype SWORD v2 specification will be written. The specification will detail the SWORD v2 protocol to a level where it can be discussed, evaluated, and implemented.The specification will be considered a draft as it is envisaged that during the later implementation phase that the specification will change in light of user experience and evaluation.

Work package 5: Server implementations

  • Once the prototype specification has been written, a server implementation will be required. This will be used in conjunction with the client implementations (work package 6) to test the specification and evaluation it against the use cases and requirements as specified earlier in the project.  The server implementations should attempt to provide some mechanism by which client requests can be validated.  All resultant code will be released with a suitable open source licence.Three server implementations will be created, one each for DSpace, EPrints, and Fedora.  If appropriate and possible, other server implementations will be encouraged with technical support from the project.

Work package 6: Client implementations

  • Once the prototype specification has been written, client implementation will be required. This will be used in conjunction with the server implementations (work package 5) to test the specification and evaluation it against the use cases and requirements as specified earlier in the project.  The client implementations should attempt to provide some mechanism by which they can be used to validate a sword endpoint.There will be 4 client implementations created, to offer a highly heterogeneous environment within which to test the use cases and requirements.  They are also designed to offer a series of multi-language software libraries for easy use within other systems not dealt with here. All resultant code will be released with a suitable open source licence.  The clients will include Java, PHP, Ruby and Phython code.

Work package 7: Instructional documentation and ongoing community management

  • In order to be empowered to interact with the SWORD v2 standard the community will require instructional documentation to make use of the proposed new standard. This will take the form of code examples, training materials, and support.The community will need facilitation to ensure it interacts with the standard and the demonstration implementations. This will be achieved through the provision of support, advocacy and publicity of the standard the implementations.As well as ensuring the user and developer communities adopt SWORD v2 and feel ownership of it, the work of advocating, educating and promoting SWORD v1. This will be achieved by maintaining the SWORD v1 website, and by seeking further opportunities to teach ‘The SWORD Course’ at suitable events.

Work package 8: Develop a sustainability plan

  • A viable sustainability plan is required to ensure the ongoing development and maintenance of the SWORD protocol standard,the implementations, and the advocacy.

Work package 9: Support the JISCDepo projects

  • The JISCDepo programme (#jiscdepo) is a suite of projects that work in the area of repository deposit. This work package will support the JISCDepo projects to use SWORD v2 where applicable, and ensure the SWORD v2 standard meets any suitable requirements that they have.The work will be undertaken by UKOLN through the DevCSI infrastructure. In addition to supporting the JISCDepo programme, they will support the use of SWORD in the wider repository programme of projects funded by JISC. If appropriate, the involvement of DevCSI will be used to run a community development event to bring together developers to experiment and develop with the SWORD v2 standard.

Work package 10: Project dissemination

  • In addition to the advocacy and community development of SWORD v2 through the use of the project website, blog, and other activities, the project will also disseminate its findings, the developments it has created, and encourage community interaction by attending major repository events.  Additionally the project will seek to work with existing support networks such as the RSP to deliver training and and advocacy through their programmes of events.

Work package 11: Project administration

  • The project will require standard JISC project management activities to take place. These include formal project plans, reports, budgets, and attendance at relevant programme meetings. Overheads and administration costs will be required for UKOLN to support these activities and the general running of the project.

Leave a Reply

Your email address will not be published. Required fields are marked *