Bijlage 3 Technische Conserveringsdocumentatie
Een aanzet voor een template voor documentatie, afgeleid van software engineering documentatie
1. Algemene Projectinformatie
- Titel project:
- Maker(s) / Studio:
- Productiejaar:
- Omschrijving: (korte inhoud + vorm, bijv. VR installatie, AR app)
2. Gebruikte Game Engine
- Engine: Unity / Unreal Engine
- Versie:
- Build type: (Standalone, WebXR, Mobile, etc.)
3. Software Runtime Environment
- Doelplatform(en): (bijv. Oculus Quest 2, HTC Vive, browser)
- Besturingssysteem: (bijv. Windows 10, Android 11)
- Hardware-vereisten: CPU, GPU, RAM, HMD-type
- Input methoden: Controllers, hands, tracking, etc.
4. Engineconfiguratie
- Render pipeline (Unity): Built-in / URP / HDRP
- Graphics settings: resolutie, anti-aliasing, shadows, shaders
- Physics engine: standaard / aangepast
- Audio engine: standaard / third-party plug-in
- Network config (indien van toepassing): multiplayer framework of protocols
5. Externe Software Libraries / Plug-ins
Een lijst van alle externe packages die zijn toegevoegd aan het project: Bijvoorbeeld:
Naam library / middleware Versie Functie / Omschrijving Herkomst / bron VRTK 4.0.0 VR interaction toolkit (Unity) GitHub / Unity Asset Store FMOD 2.02 Audio middleware https://fmod.com
OpenCV 4.5.1 Beeldherkenning open-source AR Foundation 4.1.5 AR-functionaliteit (Unity) Unity Package Manager
6. Buildinformatie
- Build tool: Unity Build-in / Unreal Build / CI pipeline
- Laatste werkende build: versienummer + datum
- Build output: APK, EXE, WebGL etc.
- Build settings exportbestand: [bijgevoegd .json / .xml / .ini]
7. Versiebeheer & Brondocumentatie
- Versiebeheersysteem: Git / SVN / anders
- Repository-URL of backuplocatie:
- Instructies voor rebuild: stappenplan (optioneel in README.md)
- Licentie-informatie (software en assets)
8. Hardware- en Fysieke Componenten
- Apparatuur: Lijst van benodigde hardware (computers, VR/AR-headsets, schermen, projectoren, speakers, sensoren, microfoons, haptische vesten, etc.) Specificaties: merk, model, OS, firmwareversies, aansluitingen
- Props & Decoratieve elementen: Objecten zoals meubels, (nep-)apparatuur, kleding, decorstukken Afmetingen, materialen, opbouw- en opslaginstructies
- Technische installaties: Licht- of geluidsapparatuur, rookmachines, windmachines, bewegende onderdelen (bv. servo’s of motoren) Schema’s van aansluitingen en onderhoudsbehoeften
- Installatierichtlijnen: Ruimtelijke vereisten (m² per persoon, plafondhoogte) Set-up tijd en benodigde technische crew Training van hosts of technici
9. Artistieke Specificaties
- Artistieke intentie (kort): (bijv. wat zijn cruciale elementen die niet verloren mogen gaan?)
- Goed te keuren installatiemodellen: (bijv. instellingen voor tentoonstellingen of events)
10. Known Issues & Notes
- Bekende bugs, beperkingen
- Technische afhankelijkheden (bv. specifieke softwareversies, incompatibiliteit)
- Toelichting op keuzes (bijv. waarom een bepaalde middleware werd gebruikt)
11. Bijlagen
- Screenshots van interface & installatie
- Schemas van software-architectuur of runtime environment
- Licentiebestanden, binaries, installatiemappen, README.md
- Eventueel: video-opnames of walkthrough van installatie