Quick Style Guide

Think ‘user experience’ not ‘encyclopaedia’ or ‘magazine’.

  • Give facts and figures based on your experience of what happened on your major project. Include analysis on what you consider worked well and what didn’t with your recommendations for the next project.  Share supporting documents to provide context and further information.
  • Avoid the ‘it was all wonderful’ approach, setting out the problems and difficulties as well as the successes and the lessons learned for future projects.
  • Content should be a fairly formal style. Text should be UK English in the third person and should be readily understandable by a professional person.
  • Do not refer to the names of individuals, organisations, products or services unless it is essential to understanding your article (and then only the first time). Do not gratuitously compliment or be derogatory in any way about any person or organisation.
  • Make text as short and concise as possible, excluding anything that is not directly relevant to the subject. Include any associated safety, environmental or ethical issues.
  • Include acknowledgement to those who have contributed to the work: principal participants in a project, contributors and interviewees for the paper, and reviewers.
  • References should be numbers and referred to in the text by the reference number using superscript [1][2]. Use the “Vancouver” reference style:

[1] Kofoed, V.O, Montgomery, J and Gardiner, K.D. (2006). Identifying Leakage Paths in Earthen Embankments. Proceedings of 14th Conference of the British Dam Society – Thomas Telford Ltd

Make your article accessible

  • Give your article a simple plain language title
  • Include a summary introducing the resource and summarising the key points.
  • Break the article down into headings such as:
    1. Introduction and industry context
    2. Main story
    3. Lessons learned and good practice
    4. Recommendations for future projects
    5. Conclusion
  • Explain project specific or specialist terms and avoid the use of acronyms and colloquialisms.
  • Avoid long paragraphs
  • Use bullet point lists to make information clear and accessible
  • Use diagrams/graphs/photos/drawings where possible to support the text
  • Don’t use capitalisation unless absolutely necessary as this format is difficult to read

Uploading to the Knowledge Hub

  • Keep formatting as simple as possible. Plain text, headings and bulleted lists.  Pasting text with more complex editing can confuse the text editor
  • Use hi-resolution images (file size 1-3MB).
  • Adding tags will enable your article to be more easily found. Take some time to choose the right themes and sub-themes when uploading.

Moderation

It is essential that all content on the Hub is high quality and useful hence there is a moderation process coordinated by the Knowledge Hub Administrator.

Once you have submitted your article/resource for publication the Knowledge Hub Administrator will review against the following criteria:

  • Does it follow the style guidelines? The Administrator will undertake a light edit where appropriate to ensure that the content meets the style guidelines.  If more substantial changes are required then the Administrator will feedback comments to the Contributor for amendment.
  • Does the content add to the body of knowledge on major projects? The Administrator or an assigned Peer Reviewer (depending on the type of resource) will review the Content to confirm that it meets the overall objective of improving initiation and delivery of major projects.  They will ask questions such as:
  • Is enough detail provided for it to be useful to future projects? A common mistake is for articles/resources to lack specificity, be too high level or need more supporting data.
  • Are lessons learned and good practice presented in a clear way and are the recommendations relevant and scalable for other projects? Many lessons learned articles are focused on ‘naval gazing’ and struggle to articulate what should be done differently on the next project.
  • Is anything missing from the Content?
  • Could the article benefit from additional supporting documents?  Many learning legacy papers refer to key documents used on the project.  It is useful to share these for context.

The Administrator will collate comments and feedback to the Contributor by email for update.  Each comment will be assigned a status – Essential (needs to be updated before publication) or Advisable (update at the Contributor’s discretion).