This is an old revision of the document!


Best Practices for Managing This Wiki

Topics on this page address common practices, or standards, for creating, editing and managing content on the Acquisitions, Cataloging & Processing Staff Wiki. Applying these conventions will create a more friendly environment for wiki users. In addition to what's covered here, the Best Practice Guidelines for Web Content Creation is a useful and relevant document.

Naming new pages

When you create a new page, type the shortest, most descriptive and sensible title possible. Start with a word that is essential to what the file is about, e.g. “serials” or “monographs”, rather than its type, e.g. “workflow” or “procedure”. Give this some thought before you actually create the file. Make it plain English. It's easier to choose a good name at the outset than it is to delete a file and create a new one with a better name.

Applying headings

Headings are used to delineate sections or topics within a page. In addition to making it easier to browse the contents of the page, the headings also automatically generate the Table of Contents which appears at the top right of the page. The Table of Contents gives a brief page outline and enables you to go to a given section of the page by following the heading link. At a minimum, please apply these headings:

  • H1 - to the page title
  • H2 - to a main section or topic covered

Adding contact information

Each page should have at the bottom a note about who is primarily responsible for maintaining its content. This does not preclude others from making changes to the page, but it's useful to know of whom one can ask questions, report errors, make suggestions, etc.

At the bottom of each page you are responsible for creating and maintaining on the wiki, add a line with your name and an email link. The format should look like this: Primary contact: Christine Turner. Refer to the edit mode to see the syntax.

Linking new pages

When you save a new page, it will automatically appear within the alphabetical list in the Index column to the left of the Start page. Depending on the subject of the page, you will need to add the filename (page title) to the Start page within the appropriate functional area(s). It may be listed in more than one place, as appropriate. To create a link to a new file on the start page: Go to the start page, click on edit this page, add the page title within double brackets.

Documenting workflows that span across both departments

A job that involves multiple units should be documented in one file and linked from multiple departmental areas of the home page. Furthermore, headings should be used to designate different parts and areas of responsibility, thus generating the file’s Table of Contents and navigation links. For a good example of this, please see the Serials New Titles file which covers steps taken in several units to add a new serial title to our collections.

best_practices_for_managing_this_wiki.1233584901.txt.gz · Last modified: 2019/01/07 17:20 (external edit)
www.chimeric.de Creative Commons License Valid CSS Driven by DokuWiki do yourself a favour and use a real browser - get firefox!! Recent changes RSS feed Valid XHTML 1.0