Last edited 2 years ago
by Demo writer

Technical documentation

Revision as of 09:06, 3 May 2022 by Demo writer (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

BlueSpice is the platform for technical documentation.

Wiki as a tool for technical documentation
External technical documentation Interne Technische Dokumentation
It ensures that the product can be commissioned, used, maintained and, if necessary, disposed of safely and as intended.

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

Sie dient der internen Archivierung aller produktrelevanten Dokumente und der Nachweispflicht, alle rechtlichen Pflichten eingehalten zu haben. Sie kann den gesamten Produktlebenszyklus von der Produktplanung über Entwicklung, Markteinführung und Produktbeobachtung bis zur Einstellung des Produkts umfassen. Typische Bestandteile eine internen Dokumentation sind:
  • Gebrauchs-/ Betriebs-/ Bedienungsanleitung,
  • Installations- und Montageanleitung,
  • Serviceanleitungen, Wartungs- und Reparaturanleitung,
  • Software-Handbücher, Benutzerhandbuch und Online-Hilfe,
  • Projektdokumentationen,
  • Produktdokumentation und Datenblätter,
  • Sicherheitsanweisungen / Arbeitssicherheit,
  • Produktvideos, Tutorial usw.
  • Instructions for use / operating / operating instructions,
  • installation and assembly instructions,
  • Service instructions, maintenance and repair instructions,
  • software manuals, user guide and online help,
  • project documentation,
  • product documentation and data sheets,
  • safety instructions / occupational safety,
  • Product videos, tutorial, etc.

You can get a first impression at the following pages: