UKOLN AHDS Top 10 Tips For Service Deployment



About This Document

This document provides top tips which can help to ensure that project deliverables can be deployed into a service environment with the minimum of difficulties.

The Top 10 Tips

1 Document The Technical Architecture For Your Project

Provide a description of the technical architecture of aspects of your project which are intended for deployment into service. The description will be helpful for the service provider. In addition it can help the funders in gaining an appreciation of the technical approaches being taken by projects across a digital library programme as well as being of value to your project team (especially if staff leave).

2 Document Any Deviations From Use Of Recommended Standards Or Best Practices

You should ensure that your technical infrastructure which is capable of implementing your policies. For example, if you wish to make use of XHTML on your Web site you are unlikely to be able to achieve this if you are using Microsoft Word as your authoring tool.

3 Document Use Of Unusual Or Innovative Aspects Of Your Project

If you are making use of any new standards or unusual technologies you should document this, and explain the reasons for your choice. This could include use of emerging standards (e.g. SVG, SMIL), use of Content Management Systems, etc.

4 Have An Idea Of Where You Envisage Your Project Deliverables Being Deployed

Give some thought to where your deliverables will be deployed. This could be by a JISC Service, within your institution, within other institutions or elsewhere.

5 Seek To Make The Service Provider Aware Of Your Project

You should seek to make contact with the service provider for your deliverables. You should seek to gain an understanding of their requirements (e.g. see [1] [2]). In addition it can help if the service provider is aware of your work and any special requirements associated with your project.

6 Be Aware Of Legal, IPR, etc. Barriers To Service Deployment

The service provider will need to ensure that there are no legal barriers to the deployment of your deliverables. This can include clarifying copyright, IPR and accessibility issues.

7 Ensure Your Have Any Documentation Which Is Necessary To Assist Service Deployment

You should ensure that you provide installation documentation which should list dependencies on other software and cover any security or performance issues. As well as the installation documentation you should also provide user documentation which can help the service provide support for end users.

8 Remember To 'Let Go'

Although it can be helpful of your project team is in a position to provide advice to the service provider after the end of the project, the project team should also be willing to relinquish control over the project if, for example, the service provider needs to make changes to your deliverables.

9 Learn From Others

Learn from the experiences of others. For example, read the case studies which provide various examples of porting systems into a service environment [3] [4].

10 Share Your Experiences

Be willing to share your experiences. For example, consider writing a case study for QA Focus [5] [5].

References

  1. From Project To Production Service, QA Focus, UKOLN,
    <http://www.ukoln.ac.uk/qa-focus/documents/briefings/briefing-38/>
  2. Planning An End User Service, QA Focus, UKOLN,
    <http://www.ukoln.ac.uk/qa-focus/documents/briefings/briefing-39/>
  3. Launching New Database Services: The BIDS Experience, QA Focus, UKOLN,
    <http://www.ukoln.ac.uk/qa-focus/documents/case-studies/case-study-27/>
  4. Providing Access To Full Text Journal Articles, QA Focus, UKOLN,
    <http://www.ukoln.ac.uk/qa-focus/documents/case-studies/case-study-28/>
  5. Contributing To Case Studies, QA Focus, UKOLN,
    <http://www.ukoln.ac.uk/qa-focus/documents/case-studies/#contributing>
http://www.ukoln.ac.uk/qa-focus/documents/briefings/briefing-40/html/index.html
www.ukoln.ac.uk
crawl=CC-MAIN-2018-05
11171
application/http; msgtype=response
sha1:ZCOZ5M5NFG6KM5R6JFYDMUTBK4GUAM2N
<urn:uuid:9227614e-2800-4e1d-b33b-77b540d914c8>
2018-01-17T11:24:18Z
138.38.0.49
application/xhtml+xml
sha1:HKLDCOH7NI5QG62O5X6J45GM7YX2JE6V
<urn:uuid:4dbe548f-4225-4d21-8b0b-5cec0f2c9201>
http://www.ukoln.ac.uk/qa-focus/documents/briefings/briefing-40/html/index.html
response
<urn:uuid:9de52ebb-932d-40d5-9bba-eb16e5d7d27c>
robots: classic
hostname: ip-10-168-113-164.ec2.internal
software: Nutch 1.6 (CC)
isPartOf: CC-MAIN-2018-05
operator: Common Crawl Admin
description: Wide crawl of the web for January 2018
publisher: Common Crawl
format: WARC File Format 1.0
conformsTo: http://bibnum.bnf.fr/WARC/WARC_ISO_28500_version1_latestdraft.pdf