U bekijkt een oudere versie van deze pagina. Terug naar de laatste versie.
Technical Documentation: verschil tussen versies
BlueSpice is the platform 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: |
| 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: |
|
|
|
|
|
Voorbeeldpagina's[bewerken | brontekst bewerken]
You can get a first impression of these possibilities by looking at the following examplesU kunt een eerste indruk krijgen van deze mogelijkheden door naar de volgende voorbeelden te kijken:
- Electric Pallet Truck Alligator
- Caustic Soda
- Coffeemaker
- Machine elements (Product images, hierarchically arranged in the category system)
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 examplesExterne 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]]
*[[Coffeemaker_SARO_Model_SAROMICA_THERMO_24|Coffeemaker]]
*[[:Category:Machine element|Machine elements]] (Product images, hierarchically arranged in the category system)
__NODISCUSSION__
__NOSTASH__| Regel 3: | Regel 3: | ||
|+ | |+ | ||
Wiki as a tool for technical documentation | Wiki as a tool for technical documentation | ||
| − | ! | + | !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%" | | | width="50%" | | ||
| − | * | + | * gebruiksaanwijzing |
| − | * | + | * installatie- en montage-instructies |
| − | *service | + | * service-instructies, onderhouds- en reparatie-instructies |
| − | * | + | * softwarehandleidingen, gebruikershandleiding en online help |
| − | *project | + | * 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]] | *[[Electric Pallet Truck Alligator]] | ||