Difference between revisions of "Technical Documentation"

 

BlueSpice is the platform for technical documentation.

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 analysisanalyzes
  • technical drawings
  • exploded
  • documents of construction and production,
  • evidence of quality assurance measures,
  • disposal.

Example Pages[edit | edit source]

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


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 analysisanalyzes
        
        *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 lookinglookint at the following examples:
        

        *[[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__
Line 25: Line 25:
 
*calculation notes
 
*calculation notes
 
*test reports
 
*test reports
*risk assessments / risk analyzes
+
*risk assessments / risk analysis
 
*technical drawings
 
*technical drawings
 
*exploded
 
*exploded
Line 33: Line 33:
 
|}
 
|}
 
==Example Pages==  
 
==Example Pages==  
You can get a first impression of these possibilities by lookint at the following examples:
+
You can get a first impression of these possibilities by looking at the following examples:
  
 
*[[Electric Pallet Truck Alligator]]
 
*[[Electric Pallet Truck Alligator]]