Introduction to Documentation Guidelines

Introduction

This chapter explains how to write and encode documentation for LEMDO. The intended audience is writers of documentation (Technical Writers, Developers, and Project Leads).
These instructions presuppose that you are a LEMDO team member with access to the LEMDO Microsoft Teams workspace (and the LEMDO Subversion repository https://hcmc.uvic.ca/svn/lemdo) and possess a certain knowledge of encoding, LEMDO’s repository structure, and our existing documentation.

Table of Contents

Documentation Principles: Documents the key principles that we follow when writing documentation.
Documentation and the ODD File: Explains the relationship between LEMDOʼs documentation and our ODD file.
General Documentation Structure: Explains the chapter structure of LEMDOʼs documentation.
Documentation Style Guidelines: Provides the style guidelines that we follow when writing documentation.
Create and Name Documentation Files: Provides our practice for naming and committing documentation files.
Encode Documentation Files: Gives a brief introduction to encoding documentation.
Give Credit for Documentation Files: Explains how we give credit to the people that work on documentation files.
Structure of a Single Documentation File: Explains the structure of a documentation file.
Encode Intended Audience for Documentation: Documents the different audiences that we write documentation for and explains how to indicate that audience in our encoding.
Encode Sample XML: Introduces the way that we encode examples of encoding in our documentation.
Encode egXMLs: Provides our practice for encoding sample TEI encoding in our documentation.
Encode Element Names: Explains how we encode element names in prose.
Encode Attribute Names: Explains how we encode attribute names in prose.
Encode Value Names: Explains how we encode value names in prose.
Encode Non-XML Markup: Provides our practice for encoding non-XML markup (such as SGML and IML) in our documentation.
Encode Command Line Instructions: Explains how we encode examples of command line instructions in our documentation.
Encode Closing Tags: Provides our specific practice for encoding closing tags in prose.
Other Encoding Instructions: Provides extra information about examples of encoding, including information about escaped characters.
Make Links to and from Documentation: Explains our recommended practice for linking to LEMDO documentation.
Link Technical Terms to Glossary: Documents how we use and link to our sitewide glossary (GLOSS1).
Include Automatically-Generated Content in Documentation: Introduces inclusions and automatically-generated content.
Create Templates for Editors: Documents how we create template files that can be accessed in the LEMDO repository.

Prosopography

Isabella Seales

Isabella Seales is a fourth year undergraduate completing her Bachelor of Arts in English at the University of Victoria. She has a special interest in Renaissance and Metaphysical Literature. She is assisting Dr. Jenstad with the MoEML Mayoral Shows anthology as part of the Undergraduate Student Research Award program.

Janelle Jenstad

Janelle Jenstad is a Professor of English at the University of Victoria, Director of The Map of Early Modern London, and Director of Linked Early Modern Drama Online. With Jennifer Roberts-Smith and Mark Kaethler, she co-edited Shakespeare’s Language in Digital Media: Old Words, New Tools (Routledge). She has edited John Stow’s A Survey of London (1598 text) for MoEML and is currently editing The Merchant of Venice (with Stephen Wittek) and Heywood’s 2 If You Know Not Me You Know Nobody for DRE. Her articles have appeared in Digital Humanities Quarterly, Elizabethan Theatre, Early Modern Literary Studies, Shakespeare Bulletin, Renaissance and Reformation, and The Journal of Medieval and Early Modern Studies. She contributed chapters to Approaches to Teaching Othello (MLA); Teaching Early Modern Literature from the Archives (MLA); Institutional Culture in Early Modern England (Brill); Shakespeare, Language, and the Stage (Arden); Performing Maternity in Early Modern England (Ashgate); New Directions in the Geohumanities (Routledge); Early Modern Studies and the Digital Turn (Iter); Placing Names: Enriching and Integrating Gazetteers (Indiana); Making Things and Drawing Boundaries (Minnesota); Rethinking Shakespeare Source Study: Audiences, Authors, and Digital Technologies (Routledge); and Civic Performance: Pageantry and Entertainments in Early Modern London (Routledge). For more details, see janellejenstad.com.

Joey Takeda

Joey Takeda is LEMDO’s Consulting Programmer and Designer, a role he assumed in 2020 after three years as the Lead Developer on LEMDO.

Martin Holmes

Martin Holmes has worked as a developer in the UVicʼs Humanities Computing and Media Centre for over two decades, and has been involved with dozens of Digital Humanities projects. He has served on the TEI Technical Council and as Managing Editor of the Journal of the TEI. He took over from Joey Takeda as lead developer on LEMDO in 2020. He is a collaborator on the SSHRC Partnership Grant led by Janelle Jenstad.

Navarra Houldin

Project manager 2022–present. Textual remediator 2021–present. Navarra Houldin (they/them) completed their BA in History and Spanish at the University of Victoria in 2022. During their degree, they worked as a teaching assistant with the University of Victoriaʼs Department of Hispanic and Italian Studies. Their primary research was on gender and sexuality in early modern Europe and Latin America.

Nicole Vatcher

Technical Documentation Writer, 2020–2022. Nicole Vatcher completed her BA (Hons.) in English at the University of Victoria in 2021. Her primary research focus was womenʼs writing in the modernist period.

Tracey El Hajj

Junior Programmer 2019–2020. Research Associate 2020–2021. Tracey received her PhD from the Department of English at the University of Victoria in the field of Science and Technology Studies. Her research focuses on the algorhythmics of networked communications. She was a 2019–2020 President’s Fellow in Research-Enriched Teaching at UVic, where she taught an advanced course on Artificial Intelligence and Everyday Life. Tracey was also a member of the Map of Early Modern London team, between 2018 and 2021. Between 2020 and 2021, she was a fellow in residence at the Praxis Studio for Comparative Media Studies, where she investigated the relationships between artificial intelligence, creativity, health, and justice. As of July 2021, Tracey has moved into the alt-ac world for a term position, while also teaching in the English Department at the University of Victoria.

Orgography

LEMDO Team (LEMD1)

The LEMDO Team is based at the University of Victoria and normally comprises the project director, the lead developer, project manager, junior developers(s), remediators, encoders, and remediating editors.

Metadata

Authority title Introduction to Documentation Guidelines
Type of text Documentation
Short title
Publisher University of Victoria on the Linked Early Modern Drama Online Platform
Series Linked Early Modern Drama Online
Source
TEI Customization created by Martin Holmes, Joey Takeda, and Janelle Jenstad; documentation written by members of the LEMDO Team
Editorial declaration n/a
Edition Released with Linked Early Modern Drama Online 1.0
Encoding description Encoded in TEI P5 according to the LEMDO Customization and Encoding Guidelines
Document status prgGenerated
Funder(s) Social Sciences and Humanities Research Council of Canada
License/availability This file is licensed under a CC BY-NC_ND 4.0 license, which means that it is freely downloadable without permission under the following conditions: (1) credit must be given to the author and LEMDO in any subsequent use of the files and/or data; (2) the content cannot be adapted or repurposed (except in quotations for the purposes of academic review and citation); and (3) commercial uses are not permitted without the knowledge and consent of the editor and LEMDO. This license allows for pedagogical use of the documentation in the classroom.