m ((username removed) (log details removed)) |
No edit summary Tag: 2017 source edit |
||
| Line 1: | Line 1: | ||
{{ContentNav|homelink=Documentation | {{ContentNav|homelink=Documentation system|hometext=3|pagePrevious=|pageNext=Process map{{!}}Process map}} | ||
[[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. | 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 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 in a wiki== | ==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. | 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. | |||
* | |||
*The | |||
==Example pages== | ==Example pages== | ||
{{Portal flex/Start | |||
|colnum=2 | |||
|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:companyinfo screen de.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">[[Datei:screenshot-anleitung-kaffeemaschine.png{{!}}alternativtext=Screenshot zur Anleitung Kaffee kochen{{!}}center{{!}}450x450px{{!}}|link=Coffeemaker]]</div> | |||
|hdstatus=Nein | |||
}} | |||
{{Portal flex/Box | |||
|heading=[[IT-Dokumentation]] | |||
|content=<div class="screenshot">[[File:screenshot-js.png{{!}}alt=Screenshot JavaScript{{!}}center{{!}}450x450px{{!}}link=]]</div> | |||
}} | |||
{{Portal flex/Box | |||
|heading=[[Electric_Pallet_Truck_Alligator|Betriebsanweisung]] | |||
|content=<div class="screenshot">[[File:betriebsanweisung.png{{!}}alt=Betriebsanweisung{{!}}center{{!}}450x450px{{!}}link=Electric_Pallet_Truck_Alligator]]</div> | |||
}} | |||
{{Portal flex/Box | |||
|heading=[[Impulse response|Mathematical formula]] | |||
|content=<div class="screenshot">[[File:math.png{{!}}alt=mathematische Formeln{{!}}center{{!}}450x450px{{!}}link=Impulsantwort]]</div> | |||
}} | |||
{{Portal flex/Box | |||
|heading=[[:Category:Bike|Categorized product images]] | |||
|content=<div class="screenshot">[[File:produktbilder.png{{!}}alt=Screenshot Kategorienseite Produktbilder{{!}}center{{!}}450x450px{{!}}link=Category:Bike]]</div> | |||
}} | |||
{{Portal flex/End | |||
|emptybox=nein | |||
|contentbottom=<br /><br /><br /> | |||
{{ContentNav|homelink=Knowledge_Base|hometext=3|pagePrevious=|pageNext=Musterfirma_GmbH{{!}}Kundendokumentation}} | |||
}} | |||
{{ContentNav|homelink=Documentation | {{ContentNav|homelink=Documentation system|hometext=3|pagePrevious=|pageNext=Process map{{!}}Process map}} | ||
Revision as of 10:28, 3 December 2021
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 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.
Example pages
