Document Best Practices

Managing documents is important for making your site easy to search, for making internal documents easy to find and link to and for general website maintenance.

On this Page:

Is a PDF the Right Format?

Before uploading a document you should ask yourself if a document is the best format for sharing this information.

You may instead consider adding the content to an existing webpage, to a new webpage or shared in some other way.

When to Avoid PDF Content

In general, the TU website is the best option for content because it is:

  • accessible, responsive (able to resize for mobile devices)
  • easier to update and find in search engines
  • easier to track user engagement
  • easier to provide multimedia, interactive elements 
  • easier to share on social media

When to Opt for a PDF

PDFs can be useful when:

  • content is primarily for printing
  • there is complex formatting, such as charts and forms

If you do need to share your content in a document format, the following information will help you provide the best experience for your site visitors.

Uploading and Linking to Documents

There are several best practices when it comes to providing access to documents.

  • Always link to the official version of a document — do not upload a separate version of another office’s document to your site section.
  • When uploading documents, always upload them to the “documents folder” so that your documents are in one place and you can ensure duplicates are not uploaded.
  • Always upload documents in the “staging environment” and then submit for approval or publish.
  • When linking to documents in the content management system, all documents must be set to “open in a new window.”

Naming Documents

Always use a generic file name to correctly name your documents.

For example, instead of “summerrequestform-revision11-approved092828.pdf,” name the file something that is understandable and short, such as “summer-request-form.pdf.”

File names must be lowercase, contain no spaces or special characters and use a hyphen between words.

Deleting Documents

It is important to remove old and unused documents from the website. Even after removing document links, documents can continue to be found in search results.

To have a document removed from the CMS, submit a TechHelp service request. Follow these instructions in the request:

  1. Select "Open a Ticket"
  2. Select "Web Content & Publishing"
  3. Select "University Website & Modern Campus CMS"
  4. Select "Open a Ticket"
  5. Enter the name of the document and the file path where it is located

Overwriting Documents

Instead of uploading a completely new file when a document is changed, you should overwrite the existing document.

Overwriting documents ensures:

  • links to the document remain intact
  • existing search engine results will continue to function
  • you can avoid deleting old versions of a document from the server. This is another reason to use a generic file name when uploading documents.

For instructions on how to overwrite documents see Overwriting an Existing Document (PDF).