Documentation Julia Flanders Brown University Women Writers Project
Julia_Flanders@Brown.edu

Copyleft 2006 Julia Flanders and Brown WWP

 Stanford Humanities Center

This is the source.

 automatically converted from presentation.odd conforming to yaps.odd conforming using p2y.xslt and p2y.perl
Documentation

Documentation is crucial: For training For consistent results (across staff and time) For organizational memory: why did we do it this way? For public exchange and comprehension

Documentation in a TEI context

TEI header: File identity Work process Methods

ODD customizations: Specific changes to schema Amplifications of prose documentation Allows easier migration in future

Additional documentation: Tracking databases Name authority controls, etc. Rationales for decisions, records of discussions (e.g. on a wiki or listserv)

Use of TEI header document for the public: publication facts, project description, encoding and transcription methods document for internal purposes: revision description, special notes on this text (e.g. things that were handled as special cases; peculiarities of the text)

Use of ODD: More formal documentation of your TEI schema A record of the exact constraints you place on your encoding Also allows you to provide accompanying prose documentation Makes it easier to share this information with other projects, preserve it for your own long-term use Makes it easier to upgrade to future versions of the Guidelines, or to make further customizations

Additional documentation work flow: avoiding version control problems, making sure you know what step of the process each document is at, knowing who is responsible for each document project decisions about process and method: ensure consistency, ensure a cogent rationale, improve training and avoid confusion contextual information: e.g. databases of names