You are viewing an old version of this page. Return to the latest version.
Difference between revisions of "Technical Documentation"
(Tag: 2017 source edit) |
m (Tag: Visual edit) |
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: |
|
|
Example Pages[edit | edit source]
You can get a first impression of these possibilities by 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 analyzes
* technical drawings
* exploded
* documents of construction and production,
* evidence of quality assurance measures,
* disposal.
|}
<br />
==Example Pages==
You can get a first impression of these possibilities by lookint at the following examples:
*[[Electric Pallet Truck Alligator]]
*[[Caustic soda]]
*[[Coffeemaker]]| Line 11: | Line 11: | ||
|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: | |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%" | | + | | width="50%" | |
| − | * operating instructions | + | *operating instructions |
| − | * installation and assembly instructions | + | *installation and assembly instructions |
| − | * service instructions, maintenance and repair instructions | + | *service instructions, maintenance and repair instructions |
| − | * software manuals, user guide and online help | + | *software manuals, user guide and online help |
| − | * project documentation | + | *project documentation |
| − | * product documentation and datasheets | + | *product documentation and datasheets |
| − | * safety instructions / occupational safety | + | *safety instructions / occupational safety |
| − | * product videos, tutorials, etc. | + | *product videos, tutorials, etc. |
| | | | ||
| − | * specifications | + | *specifications |
| − | * requirements specifications | + | *requirements specifications |
| − | * calculation notes | + | *calculation notes |
| − | * test reports | + | *test reports |
| − | * risk assessments / risk analyzes | + | *risk assessments / risk analyzes |
| − | * technical drawings | + | *technical drawings |
| − | * exploded | + | *exploded |
| − | * documents of construction and production, | + | *documents of construction and production, |
| − | * evidence of quality assurance measures, | + | *evidence of quality assurance measures, |
| − | * disposal. | + | *disposal. |
|} | |} | ||
| − | |||
| − | |||
==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 lookint at the following examples: | ||