Guide to preparing a Research Framework for the web

When you are putting together a Research Framework there are a number of standards required to ensure that the network is consistent. It is also worth remembering that web pages function very differently to a monograph or paper publication. Before creating your pages look at other Frameworks on the site and map out what pages will be needed, and what menu structure works best for your Framework.

Before writing, or commissioning sections of your Framework

Consider you audience – remember that the Frameworks website is for everyone, therefore non-specialists will be reading your work.

  • Write a non-specialist, plain text introduction to make it more accessible to all
  • Less is more – try to write less, long web pages are difficult to navigate and harder to read.
  • Break up text into paragraphs of just one or two sentences
  • Think about bullets and subheadings to assist with navigation and to break up the text
  • Include links if useful (but check they are likely to be stable links)
  • Agree a standard use of terms across the whole Framework (eg. Bibliography or References) – ensure all authors are aware of this
  • Be clear about period dates – ensure all authors are working to the same dates
  • Keep sentences short
  • Avoid jargon – or consider a glossary for the Framework if this is unavoidable

It is a good idea to test for readability; this can be done within Microsoft Word or by using the Hemingway App.

Tips for putting together pages on the website

Menus – look at other frameworks for examples, keep menu titles short, use nesting under titles for more pages on the menu. Always include the 3 standard menu items;

  • Introduction to Research Frameworks
  • How to use the Research Frameworks site
  • Register/Login

Use of images – captions, Alt-text, resolution, featured image


Use of Template – ensure that if the page has headings (H2 and H3) the template used is Default template; if no headings are used in the text (eg. it’s a very short page) change the template to Full Width.

Use of heading tags

Centralisation of images, or inline text

Use of the caption option on images, not an extra block

Consider turning on the ability to enlarge images to full screen – especially for tables or diagrams.

Alt-text – this is not necessary if there is a caption which explains the image, if the image is purely cosmetic, or if the image is described in the text.

If you use links in your text remember that you’ll need to check these periodically – use the Broken Link Checker.