Technische beschrijving software

Jan 10, Jan 13, Dec 16, Initial commit. Dec 12, Jan 5, Add files via upload. Dec 22, View code. Contributions welcome If you have any additional information to share relevant to the Log4j vulnerability, please feel free to open a Pull request. Hall of fame We would like to thank every single one of you that contributed to our GitHub page.

About Operational information regarding the log4shell vulnerabilities in the Log4j logging library. Topics log4j vulnerability cve log4shell cve cve cve You signed in with another tab or window. De volgende 9 onderwerpen horen daarom standaard in een Technisch Ontwerp te staan:. De gebruikte ontwerpstandaard moeten we in de inleiding van het technisch ontwerp benoemen.

We kunnen al een korte beschrijving toevoegen om lezers te helpen die niet bekend zijn met de ontwerpstandaard. Eventuele afwijkingen en uitbreidingen van de standaard moeten we echter uitleggen en verklaren. De ontwerpstandaard is in hoge mate afhankelijk van de technische infrastructuur. Of ontwikkeltools die bovendien eenvoudig onderhoud en besparingen op de levenscycluskosten bieden.

Aangegeven wordt hoe ze worden toegepast binnen het project. Een ontwerp kan bijvoorbeeld voor Javascript en -programmering zijn gemaakt maar vindt plaats in PHP. In het ontwerp moeten de consequenties echter duidelijk in beeld worden gebracht. IT projecten zijn kwetsbaar voor wetgevende en politieke veranderingen. Er kan bijvoorbeeld overeenstemming zijn bereikt over een specifieke regelgeving binnen de EU.

Een gebied waar men op langere termijn van Technisch Ontwerp de vruchten kan plukken, is de interface tussen de gebruiker en de zogenaamde presentatielaag. Dit zijn:. Objectdefinities moeten we voorzien met deze items. Dit is de start van een gedetailleerd technisch ontwerp. Bovendien moeten we ieder object in een UML-diagramset plaatsen. Dit helpt namelijk om de informatie samen te vatten in kleine, strakke representaties van ieder object in een standaardformaat.

In de loop van het proces vormen we de diagrammen om tot een klassendiagram dat de relatie tussen de objecten weergeeft. Aan de server kant moeten we de modules beschrijven. Gebruiksaanwijzingen voor machines, apparaten en andere CE-producten moeten aan wettelijke eisen voldoen.

Dit kunnen eisen zijn uit een richtlijn of verordening, maar ook uit een norm. Het volgende voorbeeld laat zien dat op de titelpagina het type technische documentatie is benoemd, namelijk 'Installatie- en gebruikersinstructies'. Dit wordt onder andere door de EN voorgeschreven. In de marge zie je de tekst 'These are the original English instructions': dit is een eis vanuit de Machinerichtlijn. De vertaling moet de tekst 'Dit is een vertaling van de originele Engelse handleiding' bevatten.

Ook de vermelding van de productnaam is een eis die wordt gesteld in de meeste richtlijnen. Indien de machine nog een bepaald type of model zou hebben, moet ook dat vermeld worden. Het is in principe niet verplicht om het CE-logo af te beelden.

Deze verplichting geldt alleen voor op de machine of het apparaat en eventueel de verpakking. Voor een eenduidige communicatie kiezen wij er vaak voor dit wel te doen. Het volgende voorbeeld is geen machine, maar een elektrisch apparaat. De eis om aan te duiden of het een vertaling of een originele versie betreft, geldt alleen voor machines.

Het design van de technische documentatie die wij ontwikkelen, maken we met behulp van Adobe Illustrator en InDesign. Het voorbeeld hierna laat een standaard inhoudsopgave zien voor een handleiding. Deze bevat alle gangbare secties. Vaak nemen we een dergelijke inhoudsopgave als vertrekpunt en passen die aan voor het product waarvoor we de technische documentatie schrijven.

Dit voorbeeld laat een uitgebreide inhoudsopgave zien voor een machine, gemaakt op basis van het voorgaande voorbeeld. Bij software spreken we ook van technische documentatie. De inhoudsopgave van de online help of de softwaredocumentatie heeft de vorm van een menu.

Een ander belangrijk onderdeel in goede technische documentatie is een beschrijving van het beoogde gebruik. Het volgende voorbeeld laat zien hoe bij deze machine het beoogde gebruik en onbedoelde gebruik worden beschreven. En nog een voorbeeld voor het bedoelde en onbedoelde gebruik:. In technische communicatie is topic-based schrijven een modulaire benadering van contentcreatie, waarbij de content is gestructureerd rond onderwerpen topics die kunnen worden gemengd en hergebruikt in verschillende contexten.

Een topic heeft een duidelijk begin en einde. Topic-based schrijven is zeer geschikt voor technische documentatie. Tools die deze benadering ondersteunen, slaan content doorgaans op in XHTML- of andere XML-indelingen en ondersteunen hergebruik, beheer en dynamische samenstelling van gepersonaliseerde informatie.