Sandkasten und Technische Dokumentation: Unterschied zwischen den Seiten

(Unterschied zwischen Seiten)
(Änderung 2084 von WikiSysop (Diskussion) rückgängig gemacht.)
Markierung: Rückgängigmachung
 
Markierung: 2017-Quelltext-Bearbeitung
 
Zeile 1: Zeile 1:
 
+
BlueSpice ist die Plattform für technische Dokumentationen.
 
+
{| class="wikitable"
Eine Auswahl von standardmäßig integrierten Inhaltselementen - so hauchen Sie dem Wiki Leben ein!
+
|+Wiki als Tool zur technischen Dokumentation
Wechseln Sie in den <span class="plainlinks">[{{fullurl:{{FULLPAGENAME}}|action=edit}} Bearbeitungsmodus]</span>, um die Seite selbst zu bearbeiten.
+
! style="background-color:rgb(234, 236, 240);text-align:center;box-sizing:inherit;padding:0.2em 0.4em;border:1px solid rgb(162, 169, 177);" |Externe Technische Dokumentation
 
+
! style="background-color:rgb(234, 236, 240);text-align:center;box-sizing:inherit;padding:0.2em 0.4em;border:1px solid rgb(162, 169, 177);" |Interne Technische Dokumentation
<div id="use_cases">
 
==<span class="bi bi-table"></span> Tabellen==
 
{{InfoLink|url=https://de.wiki.bluespice.com/wiki/VisualEditor/Tabellen|label=Tabellen}}
 
 
 
Tabellen haben praktische Filter- und Sortiermöglichkeiten. Zum Filtern und Sortieren können Benutzer im Ansichtsmodus auf die jeweilige Kopfzeile einer Spalte klicken. Diese Funktion steht im Bearbeitungsmodus nicht zur Verfügung. Beispiel einer filterbaren Tabelle:<br />
 
{| class="wikitable filterable" style="width:100%;"
 
!Funktion!!Wert
 
 
|-
 
|-
|Filterbare Tabelle||funktioniert
+
| style="box-sizing:inherit;padding:0.2em 0.4em;border:1px solid rgb(162, 169, 177);" |Sie stellt sicher, dass das Produkt sicher und bestimmungsgemäß in Betrieb genommen, verwendet, gewartet und ggf. entsorgt werden kann.
 +
Die externe Dokumentation wird in der Regel von Technischen Redakteuren erstellt und meist in die Sprache der jeweiligen Anwender übersetzt. Beispiele für externe technische Dokumentationen:
 +
| style="box-sizing:inherit;padding:0.2em 0.4em;border:1px solid rgb(162, 169, 177);" |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:
 
|-
 
|-
|Kategoriencheck||nicht vorhanden
+
| style="box-sizing:inherit;padding:0.2em 0.4em;border:1px solid rgb(162, 169, 177);" |
|-
+
* Gebrauchs-/ Betriebs-/ Bedienungsanleitung,
|Sortierbare Tabelle
+
* Installations- und Montageanleitung,
|funktioniert
+
* Serviceanleitungen, Wartungs- und Reparaturanleitung,
 +
* Software-Handbücher, Benutzerhandbuch und Online-Hilfe,
 +
* Projektdokumentationen,
 +
* Produktdokumentation und Datenblätter,
 +
* Sicherheitsanweisungen / Arbeitssicherheit,
 +
* Produktvideos, Tutorial usw.
 +
| style="box-sizing:inherit;padding:0.2em 0.4em;border:1px solid rgb(162, 169, 177);" |
 +
* Spezifikationen,
 +
* Pflichtenhefte,
 +
* Berechnungsunterlagen,
 +
* Versuchsberichte,
 +
* Risikobeurteilungen/ Risikoanalysen,
 +
* technische Zeichnungen,
 +
* Explosionszeichnungen,
 +
* Unterlagen der Konstruktion und Fertigung,
 +
* Nachweise über Maßnahmen der Qualitätssicherung,
 +
* Entsorgung.
 
|}
 
|}
==<span class="bi bi-diagram-3-fill"></span> Diagramme / Infografiken==
+
Ein erster Eindruck der Möglichkeiten kann man über diese Beispielseiten gewinnen:
{{InfoLink|url=https://de.wiki.bluespice.com/wiki/Handbuch:Erweiterung/DrawioEditor|label=Diagramme}}
 
 
 
Ablaufdiagramme, Organigramme, Prozesslandkarten, BPMN-Diagramme und mehr. Hier als Beispiel eine Infografik, erstellt mit dem eingebunden drawio-Tool:
 
 
 
<bs:drawio filename="Sandkasten-11346612" />
 
==<span class="bi bi-camera-video"></span> Videos==
 
{{InfoLink|url=https://de.wiki.bluespice.com/wiki/Handbuch:Erweiterung/EmbedVideo|label=Videos}}
 
 
 
Video geht natürlich auch. Egal, ob es direkt im Wiki gespeichert ist oder ob es auf einem gängigen Video-Service läuft. Hier ein Video, das ins Demowiki hochgeladen wurde:
 
 
 
[[Datei:gizmo.mp4]]<br />
 
==<span class="bi bi-list-ul"></span> Seitenlisten==
 
{{InfoLink|url=https://de.wiki.bluespice.com/wiki/Handbuch:Erweiterung/BlueSpiceSmartList|label=Smartlist}}
 
 
 
Mit der integrierten Erweiterung ''Smartlist'' lassen sich ganz leicht Seitenlisten erstellen. <smartlist new="false" count="7" trim="false" />
 
 
 
==<span class="bi bi-input-cursor-text"></span> Inputbox==
 
{{InfoLink|url=https://de.wiki.bluespice.com/wiki/https://de.wiki.bluespice.com/wiki/Seiten_erstellen/Inputbox|label=Inputbox}}
 
Inputboxen sind praktische Werkzeuge, um neue Seiten in bestimmte Namensräume (Wikibereiche) zu lenken. Eine Seite, die Sie hier anlegen, wird im Namensraum IMS gespeichert:<inputbox>
 
type=create
 
prefix=IMS:
 
break=no
 
width=30
 
buttonlabel=Seite erstellen
 
</inputbox>
 
<br />
 
==<span class="bi bi-code-slash"></span> Codebeispiele dokumentieren==
 
{{InfoLink|url=https://de.wiki.bluespice.com/wiki/Handbuch:Erweiterung/SyntaxHighlight|label=SyntaxHighlight}}
 
 
 
Code läßt sich übersichtlich über die enthaltene Erweiterung ''SyntaxHighlight'' darstellen:<syntaxhighlight lang="php" line="1">
 
<?php
 
echo "Hallo Welt";
 
?>
 
</syntaxhighlight>
 
 
 
==<span class="bi bi-rss"></span> RSS-Feed==
 
{{InfoLink|url=https://de.wiki.bluespice.com/wiki/RSS-Feeds|label=RSS-Feeds}}
 
 
 
Hier ein Feed aus Bluespice.com. Mit oder ohne Beschreibung formatierbar.<rss max="4" highlight="MediaWiki BlueSpice">https://blog.bluespice.com/feed/</rss>
 
 
 
==<span class="bi bi-emoji-smile"></span> Emoticons==
 
{{InfoLink|url=https://de.wiki.bluespice.com/wiki/Handbuch:Erweiterung/Emoticons|label=Emoticons}}
 
 
 
Weil sie immer noch Spaß machen. Smileys sind mit an Bord.
 
 
 
Hello :-)
 
<br />
 
==<span class="bi bi-calculator"></span> CountThings==
 
{{InfoLink|url=https://de.wiki.bluespice.com/wiki/Handbuch:Erweiterung/BlueSpiceCountThings|label=CountThings}}
 
 
 
<bs:countcharacters mode="words">SmokeTest</bs:countcharacters>
 
==<span class="bi bi-diagram-2"></span>  Kategorienbaum==
 
{{InfoLink|url=https://de.wiki.bluespice.com/wiki/Handbuch:Erweiterung/BlueSpiceCategoryTree|label=Kategorienbaum}}
 
 
 
Der Kategorienbaum zeigt die Kategorienhierarchie - mal mit, mal ohne die zugehörigen Seiten. Ganz wie Sie wollen...
 
<categorytree>Produkt</categorytree>
 
==<span class="bi bi-cloud"></span>  Tag Cloud==
 
{{InfoLink|url=https://de.wiki.bluespice.com/wiki/Handbuch:Erweiterung/BlueSpiceTagCloud|label=Tag Cloud}}
 
 
 
Welche Kategorie wächst am schnellsten? Mit einer TagCloud sehe ich es auf den ersten Blick.
 
 
 
<bs:tagcloud width="98%" float="left" count="10" renderer="text" store="category" showcount="true" minsize="5" maxsize="30" exclude="Pages with syntax highlighting errors, Pages with borken file links, Pages with RSS feeds, Pages with broken file links" />
 
 
 
<br />
 
==<span class="bi bi-calendar-week"></span>  Widgets==
 
{{InfoLink|url=https://de.wiki.bluespice.com/wiki/Referenz:Widgets|label=Widgets}}
 
 
 
Iframes, Google Kalendar, Wetteranzeige und mehr. Oder eigene Widgets entwickeln.
 
 
 
{{#widget:Weather}}
 
 
 
</div>
 
  
[[de:{{FULLPAGENAME}}]]  
+
* [https://de.demo.bluespice.com/wiki/Elektro-Hubwagen_Alligator Elektro-Hubwagen Alligator]
[[en:Sandbox]]
+
* [https://de.demo.bluespice.com/wiki/%C3%84tznatron Ätznatron]
 +
* [https://de.demo.bluespice.com/wiki/Kaffeemaschine Kaffeemaschine]
 +
* [https://de.demo.bluespice.com/wiki/Kategorie:Fahrrad Kategorisch geordnete Produktbilder]

Version vom 3. Mai 2022, 09:44 Uhr

BlueSpice ist die Plattform für technische Dokumentationen.

Wiki als Tool zur technischen Dokumentation
Externe Technische Dokumentation Interne Technische Dokumentation
Sie stellt sicher, dass das Produkt sicher und bestimmungsgemäß in Betrieb genommen, verwendet, gewartet und ggf. entsorgt werden kann.

Die externe Dokumentation wird in der Regel von Technischen Redakteuren erstellt und meist in die Sprache der jeweiligen Anwender übersetzt. Beispiele für externe technische Dokumentationen:

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.
  • Spezifikationen,
  • Pflichtenhefte,
  • Berechnungsunterlagen,
  • Versuchsberichte,
  • Risikobeurteilungen/ Risikoanalysen,
  • technische Zeichnungen,
  • Explosionszeichnungen,
  • Unterlagen der Konstruktion und Fertigung,
  • Nachweise über Maßnahmen der Qualitätssicherung,
  • Entsorgung.

Ein erster Eindruck der Möglichkeiten kann man über diese Beispielseiten gewinnen:

Keine Kategorien vergebenBearbeiten

Diskussionen

Anhänge