Documentation System: Difference between revisions

Latest revision as of 13:40, 21 November 2022

Tour 3 Documentation System next: Customer documentation

A documentation system supports the company in archiving documents. These systems are of outstanding importance for the company to be able to reproduce processes, decisions and agreements.

Documentation systems are used in project documentation, technical documentation or IT documentation. In order for them to fulfill their purpose, it is necessary to be able to use them to quickly collect, categorize and retrieve information.

Documentation in a wiki

Wikis were developed to centrally collect and organize the knowledge of different experts. They are therefore ideal documentation systems and have long since become the standard documentation system, not least in IT.

Collaboration without prior knowledge: With the visual editor, images can be quickly integrated into an article using "drag & drop".
Office documents: Documents in other formats (Office, PDF etc.) can be attached to an article just as quickly.
Creation of structured data: The documentation can be enriched with structured data (attributes) that can be processed inside and outside the system. (Semantic MediaWiki)
Page versioning: The traceability and reproducibility of all changes in the documentation enable the management of legally required information and, if necessary, safeguard against liability.

@@ Line 1: / Line 1: @@
-{{ContentNav|homelink=Documentation System|hometext=3|pagePrevious=|pageNext=Process map{{!}}Process map}}
+{{ContentNav|homelink=Documentation System|hometext=3|pagePrevious=|pageNext=YourCompany{{!}}Customer documentation}}
+[[File:Dokumentation_Graphic_EN.png|link=Special:FilePath/Dokumentation_Graphic_EN.png|alt=infographic different types of documentation|right|320x320px]]
 A '''documentation system''' supports the company in archiving documents. These systems are of outstanding importance for the company to be able to reproduce processes, decisions and agreements.
-Documentation systems are used in project documentation, technical documentation or IT documentation. In order for them to fulfil their purpose, it is necessary to be able to use them to quickly collect, categorize and retrieve information.
+Documentation systems are used in project documentation, [[Technical documentation|technical documentation]] or IT documentation. In order for them to fulfill their purpose, it is necessary to be able to use them to quickly collect, categorize and retrieve information.
-[[File:Dokumentation Graphic EN.png|frameless|960x960px|link=Special:FilePath/Dokumentation_Graphic_EN.png]]
 ==Documentation in a wiki==
 Wikis were developed to centrally collect and organize the knowledge of different experts. They are therefore ideal documentation systems and have long since become the standard documentation system, not least in IT.
-A special feature of a wiki-based documentation system is that the development and ongoing documentation of knowledge is brought together in one system. The individual wiki article pages are "living documents". The documentation thus already begins in the planning phase. In addition comes:
+* ''Collaboration without prior knowledge:'' With the visual editor, images can be quickly integrated into an article using "drag & drop".
-*Using a high-performance search engine, you can ensure that your employees quickly find critical company information.
+* ''Office documents:'' Documents in other formats (Office, PDF etc.) can be attached to an article just as quickly.
-*With categories and namespaces you create a simple and clear classification system and fast access.
+* ''Creation of structured data:'' The documentation can be enriched with structured data (attributes) that can be processed inside and outside the system. (Semantic MediaWiki)
-*Templates and forms help you to standardize your documentation.
+* ''Page versioning:'' The traceability and reproducibility of all changes in the documentation enable the management of legally required information and, if necessary, safeguard against liability.
-*Using the visual editor, images can be quickly integrated into an article via drag&drop.
-*Attachments in other formats (Office, PDF, etc.) can also be quickly attached to an article.
-*The attachments can be enriched with metadata that can be processed inside and outside the system. (Semantics)
-With a wiki, for example, you can ensure the traceability and reproducibility of all changes in the documentation through the versioning of all changes, archive information required by law and, if necessary, protect yourself from liability.
 ==Example pages==
-See also
+{{Portal flex/Start
-*[[IT Documentation|IT documentation]]
+|colnum=2
-*[[Technical Documentation]]
+|color=grau
+|fullfirst=nein
+|boxstyle=Rahmen
+|fulllast=nein
+|showhd=Hintergrund
+|showtoc=nein
+|headers=unterstrichen
+}}
+{{Portal flex/Box
+|heading=[[YourCompany|Customer documentation]]
+|content=<div class="screenshot">[[File:screenshot-customer docu.png{{!}}alt=Screenshot of company info page|center{{!}}600x600px{{!}}Screenshot of company info page{{!}}link=YourCompany]]</div>
+|hdstatus=Nein
+}}
+{{Portal flex/Box
+|heading=[[Coffeemaker|Step-by-step instructions]]
+|content=<div class="screenshot">[[File:screenshot-coffee-instructions.png{{!}}alternativtext=Screenshot of coffee making instructions{{!}}center{{!}}450x450px{{!}}|link=Coffeemaker]]</div>
+|hdstatus=Nein
+}}
+{{Portal flex/Box
+|heading=[[IT documentation]]
+|content=<div class="screenshot">[[File:screenshot javascript.png{{!}}alt=Screenshot JavaScript{{!}}center{{!}}450x450px{{!}}link=IT documentation]]</div>
+}}
+{{Portal flex/Box
+|heading=[[Electric_Pallet_Truck_Alligator|Operating instructions]]
+|content=<div class="screenshot">[[File:screenshot-operating instructions.png{{!}}alt=operating instructions{{!}}center{{!}}450x450px{{!}}link=Electric_Pallet_Truck_Alligator]]</div>
+}}
+{{Portal flex/Box
+|heading=[[Impulse response|Mathematical formula]]
+|content=<div class="screenshot">[[File:screenshot math.png{{!}}alt=screenshot of math formulas {{!}}center{{!}}450x450px{{!}}link=Impulse response]]</div>
+}}
+{{Portal flex/Box
+|heading=[[:Category:Bike|Categorized product images]]
+|content=<div class="screenshot">[[File:product images.png{{!}}alt=Screenshot category page bike{{!}}center{{!}}450x450px{{!}}link=Category:Bike]]</div>
+}}
+{{Portal flex/End
+|emptybox=nein
+|contentbottom=<br /><br /><br />
+|}}
+{{ContentNav|homelink=Documentation System|hometext=3|pagePrevious=|pageNext=YourCompany{{!}}Customer documentation}}
-{{ContentNav|homelink=Documentation System|hometext=3|pagePrevious=|pageNext=Process map{{!}}Process map}}
+__NODISCUSSION__