Aanpak Imvertor & SaaS documentatie

Documentatie onderwerpen

• 1 Imvertor OS documentatie: Beweegt mee met Imvertor OS releases.
  • techniek. De opzet en inrichting van Imvertor. Bijvoorbeeld: de wijze waarop validatie modulen zijn gebouwd.
  • functionaliteit. De werking van Imvertor. Bijvoorbeeld: welke parameters/properties zijn er?
• 2 Imvertor SaaS documentatie. Dit betreft dan documentatie die puur de SaaS oplossing betreft en die meebeweegt met de (closed source) SaaS software.
• 3 Algemene werkprincipes en technieken. Dit is generieke documentatie, voor iedereen mogelijk relevant.
• 4 Klantspecifieke documentatie. Dit is documentatie die voor één klant is bedoeld maar waar iedereen zijn/haar voordeel mee kan doen.

Documentatie m.b.t. tooling die gebruik maakt van Imvertor (bijv. m.b.t. werkzaamheden binnen Enterprise Architect) is alleen op niveau 3 en 4 te vinden.

Verwijzingen vinden plaats vanuit 4 naar (3 naar 2 naar) 1, niet andersom.

Documentatie aanbieden volgens meerdere niveaus

• 1e lijns documentatie, soort FAQ. Bijvoorbeeld: Ik wil aan de slag. Hoe moet ik beginnen?
• 2e lijns documentatie: verdieping, nadere uitleg, procedures. Bijvoorbeeld: Inrichten van SVN binnen EA.
• 3e lijns documentatie: techniek. Bijvoorbeeld: Inrichten van conceptual schema's.

Documentatie plek geven

• Github wiki. Voordeel is intuitieve wiki omgeving, editing online, meteen zien wat je publiceert. Niet nadenken over omzetting naar website.
• Github pages. Voordeel is mooie web publicatie omgeving. Ook via GIT pull/push en releases op te zetten.
• SaaS Dashboard. Bewerking is afgeschermd, alleen voor Armatiek toegankelijk.

De keuze is ook strategisch voor Armatiek Solutions BV.