[Humanist] 31.271 structured technical documentation?

Humanist Discussion Group willard.mccarty at mccarty.org.uk
Thu Aug 31 07:18:17 CEST 2017


                 Humanist Discussion Group, Vol. 31, No. 271.
            Department of Digital Humanities, King's College London
                       www.digitalhumanities.org/humanist
                Submit to: humanist at lists.digitalhumanities.org



        Date: Wed, 30 Aug 2017 15:44:48 +0200
        From: Frederike Neuber <neuber.frederike at gmail.com>
        Subject: Q: Structured technical documentation of DH projects


Dear Humanists,

I am interested in practical and sustainable solutions for the internal
technical documentation of digital humanities projects as used by DH
centers and working groups. The type of documentation I am referring to is
not intended for the public, but would rather serve to optimize the
internal workflow of a working group in the long term. When ongoing and
terminated projects exceed a certain number, it becomes difficult to keep
track on used technologies/applications/servers, data formats, relevant
links (website, GitHub repo, etc.), responsible persons and their contact
details, and so on. It therefore might be useful to have a single “place”
where some key information about all projects (ongoing and terminated) is
captured and stored. The information should be structured to allow easy
comparison of fields as well as some basic structuring of information (such
as order according to and filter for fields). Furthermore it should be in a
sustainable format (e.g. XML) or at least be exportable to such. Finally,
in order to be accepted and used by the project team, I think the
documentation system needs to be easy to use.

My questions to you are:

1.       Do you have any schema that could serve as an example which
information might be relevant to capture for an internal technical
documentation?

 2.       Which software/application/technology/format are you using to
document technical key information about projects as mentioned above in a
structured and sustainable way?

Thank you and best wishes,

Frederike Neuber





More information about the Humanist mailing list