Overleg

Technical Documentation: verschil tussen versies

(→‎Voorbeeldpagina's)
(Label: bewerking met nieuwe wikitekstmodus)
 

BlueSpice is the platform for technical documentationhet platform bij uitstek voor technische documentatie.

Wiki as a tool for technical documentation
External technical documentation Internal technical documentation
Documentation ensures that the product can be safely and properly commissioned, used, maintained and possibly disposed of.

The external documentation is usually created by technical writers and usually translated into the language of each user. Examples of external technical documentation:

It serves the internal archiving of all product-relevant documents and the obligation to prove compliance with all legal requirements. It can span the entire product lifecycle, from product planning through development, market launch and product monitoring to product discontinuation. Typical components of an internal documentation are:
  • operating instructions
  • installation and assembly instructions
  • service instructions, maintenance and repair instructions
  • software manuals, user guide and online help
  • project documentation
  • product documentation and datasheets
  • safety instructions / occupational safety
  • product videos, tutorials, etc.
  • specifications
  • requirements specifications
  • calculation notes
  • test reports
  • risk assessments / risk analysis
  • technical drawings
  • exploded
  • documents of construction and production,
  • evidence of quality assurance measures,
  • disposal.

Example Pages[bewerken | brontekst bewerken]

You can get a first impression of these possibilities by looking at the following examples:

  • Electric Pallet Truck Alligator
  • Caustic Soda
    • Coffeemaker
    als hulpmiddel voor technische documentatie
    Externe technische documentatie Interne technische documentatie
    Documenteren zorgt ervoor dat het product veilig en correct in bedrijf gesteld, gebruikt, onderhouden en eventueel afgevoerd kan worden.

    De externe documentatie wordt meestal gemaakt door technische schrijvers en wordt meestal vertaald in de taal van elke gebruiker. Voorbeelden van externe technische documentatie:

    		Het dient voor de interne archivering van alle productrelevante documenten en de verplichting om te bewijzen dat aan alle wettelijke vereisten wordt voldaan. Het kan de hele levenscyclus van een product omvatten, van productplanning tot ontwikkeling, marktintroductie en productbewaking tot productbeëindiging. Typische componenten van een interne documentatie zijn:
    • gebruiksaanwijzing
    • installatie- en montage-instructies
    • service-instructies, onderhouds- en reparatie-instructies
    • softwarehandleidingen, gebruikershandleiding en online help
    • project documentatie
    • productdocumentatie en datasheets
    • veiligheidsinstructies / arbeidsveiligheid
    • productvideo's, tutorials, etc.


    • specificaties
    • programma van vereisten
    • berekening notities
    • testrapporten
    • risicobeoordelingen / risicoanalyse
    • technische tekeningen
    • documenten van constructie en productie,
    • certificering voor kwaliteitsborging.


    Voorbeeldpagina's[bewerken | brontekst bewerken]

    U kunt een eerste indruk krijgen van deze mogelijkheden door naar de volgende voorbeelden te kijken: 


    BlueSpice is the platform for technical documentation.
            
            {| class="wikitable"
            
            |+
            
            Wiki as a tool for technical documentation
            
            !External technical documentation
            
            !Internal technical documentation
            
            |- 
            
            |Documentation ensures that the product can be safely and properly commissioned, used, maintained and possibly disposed of.
            
            
            
            The external documentation is usually created by technical writers and usually translated into the language of each user. Examples of external technical documentation:
            
            |It serves the internal archiving of all product-relevant documents and the obligation to prove compliance with all legal requirements. It can span the entire product lifecycle, from product planning through development, market launch and product monitoring to product discontinuation. Typical components of an internal documentation are:
            
            |-
            
            | width="50%" |
            
            *operating instructions
            
            *installation and assembly instructions
            
            *service instructions, maintenance and repair instructions
            
            *software manuals, user guide and online help
            
            *project documentation
            
            *product documentation and datasheets
            
            *safety instructions / occupational safety
            
            *product videos, tutorials, etc.
            
            |
            
            *specifications
            
            *requirements specifications
            
            *calculation notes
            
            *test reports
            
            *risk assessments / risk analysis
            
            *technical drawings
            
            *exploded
            
            *documents of construction and production,
            
            *evidence of quality assurance measures,
            
            *disposal.
            
            |}
            
            ==Example Pages== 
            
            You can get a first impression of these possibilities by looking at the following examples{{DISPLAYTITLE:Technische Documentatie}}BlueSpice is het platform bij uitstek voor technische documentatie.
            
            {| class="wikitable"
            
            |+
            
            Wiki als hulpmiddel voor technische documentatie
            
            !Externe technische documentatie
            
            !Interne technische documentatie
            
            |- 
            
            |Documenteren zorgt ervoor dat het product veilig en correct in bedrijf gesteld, gebruikt, onderhouden en eventueel afgevoerd kan worden.
            
            
            
            De externe documentatie wordt meestal gemaakt door technische schrijvers en wordt meestal vertaald in de taal van elke gebruiker. Voorbeelden van externe technische documentatie:
            
            |Het dient voor de interne archivering van alle productrelevante documenten en de verplichting om te bewijzen dat aan alle wettelijke vereisten wordt voldaan. Het kan de hele levenscyclus van een product omvatten, van productplanning tot ontwikkeling, marktintroductie en productbewaking tot productbeëindiging. Typische componenten van een interne documentatie zijn:
            
            |-
            
            | width="50%" |
            
            * gebruiksaanwijzing
            
            * installatie- en montage-instructies
            
            * service-instructies, onderhouds- en reparatie-instructies
            
            * softwarehandleidingen, gebruikershandleiding en online help
            
            * project documentatie
            
            * productdocumentatie en datasheets
            
            * veiligheidsinstructies / arbeidsveiligheid
            
            * productvideo's, tutorials, etc.
            
            
            
            
            <br />
            
            |
            
            * specificaties
            
            * programma van vereisten
            
            * berekening notities
            
            * testrapporten
            
            * risicobeoordelingen / risicoanalyse
            
            * technische tekeningen
            
            * documenten van constructie en productie,
            
            * certificering voor kwaliteitsborging.
            
            
            
            
            <br />
            
            |}
            
            ==Voorbeeldpagina's== 
            
            U kunt een eerste indruk krijgen van deze mogelijkheden door naar de volgende voorbeelden te kijken:
        
        
        
        *[[Electric Pallet Truck Alligator]] *[[Caustic Soda]]
            
            
        [[Elektrische pallettruck Alligator]]
            
            *[[Caustic Soda]] [[Caustische Soda|Caustische (Bijtende) Soda]]
            
            
        *[[Coffeemaker_SARO_Model_SAROMICA_THERMO_24|Coffeemaker]] [[Koffiezetapparaat SARO Model SAROMICA THERMO 24|Koffiezetapparaat]]
            
            
        *[[:Category:Machine element|Machine elements]] (Product images, hierarchically arranged in the category system) 
            
            
        [[:Categorie:Machine onderdelen|Machine onderdelen]] (Productafbeeldingen, hiërarchisch gerangschikt in het categoriesysteem)
            
            
            
            
        __NODISCUSSION__
        
        __NOSTASH__
    (3 tussenliggende versies door een andere gebruiker niet weergegeven)
    Regel 1: Regel 1:
    −
    BlueSpice is the platform for technical documentation.
    		+
    {{DISPLAYTITLE:Technische Documentatie}}BlueSpice is het platform bij uitstek voor technische documentatie.
     
    {| class="wikitable"
    		 
    {| class="wikitable"
     
    |+
    		 
    |+
    −
    Wiki as a tool for technical documentation
    		+
    Wiki als hulpmiddel voor technische documentatie
    −
    !External technical documentation
    		+
    !Externe technische documentatie
    −
    !Internal technical documentation
    		+
    !Interne technische documentatie
     
    |-  
    		 
    |-  
    −
    |Documentation ensures that the product can be safely and properly commissioned, used, maintained and possibly disposed of.
    		+
    |Documenteren zorgt ervoor dat het product veilig en correct in bedrijf gesteld, gebruikt, onderhouden en eventueel afgevoerd kan worden.
      
    −
    The external documentation is usually created by technical writers and usually translated into the language of each user. Examples of external technical documentation:
    		+
    De externe documentatie wordt meestal gemaakt door technische schrijvers en wordt meestal vertaald in de taal van elke gebruiker. Voorbeelden van externe technische documentatie:
    −
    |It serves the internal archiving of all product-relevant documents and the obligation to prove compliance with all legal requirements. It can span the entire product lifecycle, from product planning through development, market launch and product monitoring to product discontinuation. Typical components of an internal documentation are:
    		+
    |Het dient voor de interne archivering van alle productrelevante documenten en de verplichting om te bewijzen dat aan alle wettelijke vereisten wordt voldaan. Het kan de hele levenscyclus van een product omvatten, van productplanning tot ontwikkeling, marktintroductie en productbewaking tot productbeëindiging. Typische componenten van een interne documentatie zijn:
     
    |-
    		 
    |-
     
    | width="50%" |
    		 
    | width="50%" |
    −
    *operating instructions
    		+
    * gebruiksaanwijzing
    −
    *installation and assembly instructions
    		+
    * installatie- en montage-instructies
    −
    *service instructions, maintenance and repair instructions
    		+
    * service-instructies, onderhouds- en reparatie-instructies
    −
    *software manuals, user guide and online help
    		+
    * softwarehandleidingen, gebruikershandleiding en online help
    −
    *project documentation
    		+
    * project documentatie
    −
    *product documentation and datasheets
    		+
    * productdocumentatie en datasheets
    −
    *safety instructions / occupational safety
    		+
    * veiligheidsinstructies / arbeidsveiligheid
    −
    *product videos, tutorials, etc.
    		+
    * productvideo's, tutorials, etc.
     +
     
     +
    <br />
     
    |
    		 
    |
    −
    *specifications
    		+
    * specificaties
    −
    *requirements specifications
    		+
    * programma van vereisten
    −
    *calculation notes
    		+
    * berekening notities
    −
    *test reports
    		+
    * testrapporten
    −
    *risk assessments / risk analysis
    		+
    * risicobeoordelingen / risicoanalyse
    −
    *technical drawings
    		+
    * technische tekeningen
    −
    *exploded
    		+
    * documenten van constructie en productie,
    −
    *documents of construction and production,
    		+
    * certificering voor kwaliteitsborging.
    −
    *evidence of quality assurance measures,
    		+
     
    −
    *disposal.
    		+
    <br />
     
    |}
    		 
    |}
    −
    ==Example Pages==  
    		+
    ==Voorbeeldpagina's==  
    −
    You can get a first impression of these possibilities by looking at the following examples:
    		+
    U kunt een eerste indruk krijgen van deze mogelijkheden door naar de volgende voorbeelden te kijken:
      
    −
    *[[Electric Pallet Truck Alligator]]
    		+
    *[[Electric Pallet Truck Alligator]] [[Elektrische pallettruck Alligator]]
    −
    *[[Caustic Soda]]
    		+
    *[[Caustic Soda]] [[Caustische Soda|Caustische (Bijtende) Soda]]
    −
    *[[Coffeemaker_SARO_Model_SAROMICA_THERMO_24|Coffeemaker]]
    		+
    *[[Coffeemaker_SARO_Model_SAROMICA_THERMO_24|Coffeemaker]] [[Koffiezetapparaat SARO Model SAROMICA THERMO 24|Koffiezetapparaat]]
    −
    *[[:Category:Machine element|Machine elements]] (Product images, hierarchically arranged in the category system)
    		+
    *[[:Category:Machine element|Machine elements]] (Product images, hierarchically arranged in the category system) [[:Categorie:Machine onderdelen|Machine onderdelen]] (Productafbeeldingen, hiërarchisch gerangschikt in het categoriesysteem)
      
     
    __NODISCUSSION__
    		 
    __NODISCUSSION__
     
    __NOSTASH__
    		 
    __NOSTASH__
    Overgenomen van "https://nl.demo3.bluespice.com/w/index.php?title=Technical_Documentation&oldid=3652"