Überragende Softwaredokumentation


Die Dassault Systèmes SOLIDWORKS Corp. entwickelt und vertreibt Software für die 3D-CAD-Konstruktion, die Konstruktionsanalyse und das Produktdatenmanagement. SOLIDWORKS ist führender Anbieter für 3D-CAD-Software zur Produktentwicklung.

Die Benutzersicht einzunehmen, ist beim Schreiben von Benutzerdokumentation aber eine unbedingte Voraussetzung, wenn die Dokumentation wirklich gut werden und die Fragen der Benutzer widerspiegeln soll. Damit beschleunigen Sie den Zugriff auf häufig verwendete Dateien. Es gibt aber noch einen dritten Weg, und zwar der zu bewusstem Fleischkonsum.

Funktionsreiches Hilfeentwicklungsumfeld

SupplyOn ist Experte für digitales Supply Chain Management. Das dynamische Netzwerk verbindet weltweit alle relevanten Unternehmen in der Fertigungsindustrie, die damit Innovationen schneller im Markt ausrollen, flexibel auf Schwankungen der Lieferkette reagieren und mittels künstlicher Intelligenz ihre Prozesse optimieren können.

Dennoch kaufen Verbraucher ihr Fleisch im Supermarkt oder beim Discounter um die Ecke mit mehr oder weniger schlechtem Gewissen. Aufgrund des erbarmungslosen Wettbewerbsdrucks bleibt das Tierwohl dabei häufig auf der Strecke. In der Regel werden die Tiere nur noch in Ställen aufgezogen, kennen also weder Weiden noch Tageslicht. Das wirkt sich auch negativ auf die Fleischqualität aus. Wer daran etwas ändern möchte, muss entweder auf Fleisch verzichten oder zum Edelmetzger in den Toplagen der Citys gehen.

Es gibt aber noch einen dritten Weg, und zwar der zu bewusstem Fleischkonsum. Durch Sharing von ganzen T Zwar ist der Begriff Smoothie schon mehr als hundert Jahre alt — als Foodtrend ist er allerdings erst in den letzten Jahren im Mainstream angekommen. Die gesunden Smoothies sind reine Vitaminbomben, wenn auf Zusatzstoffe wie Zucker verzichtet wird. Der ist aber meistens in fertigen Smoothies enthalten, und zwar nicht zu knapp. Damit wird der gesunde Ansatz dieses Powerfoods fast wieder zunichtegemacht.

Als Alternative bleibt eigentlich nur, von verzehrfertigen Smoothies aus dem Supermarkt Abstand zu nehmen. Selbermachen ist aber auch keine Lösung, da es viel zu zeitaufwendig ist. Ob es ein Entrinnen aus diesem Dilemma gibt?

Jeder Mensch erfährt in seinen ersten beiden Lebensjahren eine ganz besondere Fürsorge. Bis er seine Ausscheidungen eigenständig kontrollieren kann, muss er Windeln tragen, die ihm mehrmals täglich gewechselt werden.

Auch im hohen Alter bei Inkontinenz kommen Windeln zum Einsatz. Aus praktischen Gründen haben sich Einwegwindeln durchgesetzt. Sie werden einmal benutzt und wandern danach in den Müll.

Bei durchschnittlich fünf bis sechs Wechseln pro Tag kommt je Kind eine gigantische Menge an Einweg-Babywindeln zusammen. Als sie dann noch herausfanden, dass Einwegwindeln Erdöl enthalten, packte sie der Ehrgeiz nachhaltige Alternativen zu entwickeln. Dies war der Startschuss für Fairwindel, einer Elterninitiative für biologisch abbaubare Babywindeln. Seitdem das Smartphone zum ständigen Begleiter geworden ist, lassen sich immer mehr Menschen beim Shoppingbummel in ihrer Stadt oder auf Reisen von Apps beraten.

Wir navigieren zwar aktiv mit dem Mobilgerät, lassen uns aber auch passiv von ihm leiten. Über Push-Funktionen empfangen wir Nachrichten zu günstigen Angeboten oder Events, die zu unseren Interessen passen und gerade in der Nähe stattfinden. Softwaredokumentation im weitesten Sinne umfasst teilweise sehr unterschiedliche Bereiche.

Dies führt oft zu Missverständnissen. Unterteilung nach der Nutzung der Softwaredokumentation Grob unterteilen lässt sich Softwaredokumentation allgemein in Dokumentationstypen für den internen Gebrauch beim Hersteller und in Dokumentationstypen zur Weitergabe an Kunden.

Für den internen Gebrauch zählen zur Softwaredokumentation insbesondere: Oft werden diese Informationstypen daher sogar in unterschiedliche Dokumente oder Dokumentationsteile aufgeteilt, z. Unterteilung nach dem Medium der Softwaredokumentation Neben der inhaltlichen Ebene gibt es auch vom Medium her grundlegend unterschiedliche Typen von Softwaredokumentation: Eine Softwaredokumentation sollte Teil einer ganzheitlichen Software-User-Assistance sein Eine Softwaredokumentation für Benutzer sollte im Idealfall immer in einem globalen Kontext stehen: Neben der klassischen Dokumentation, bestehend aus Handbüchern und Online-Hilfen, gehören zu einer ganzheitlichen User-Assistance insbesondere auch: Grundlegende Anforderungen Die wichtigste und zugleich die am häufigsten vernachlässigte Anforderung an Softwaredokumentation ist: Eine Softwaredokumentation muss die Fragen der Kunden beantworten und sie befähigen, das Produkt vollständig und effizient zu nutzen.

Weniger Information ist zu wenig, mehr Information ist zu viel. Machen wir uns nichts vor: Technische Dokumentation, und damit auch Softwaredokumentation, wird meist nur als lästiges Übel empfunden.

Es geht beim Erstellen von Softwaredokumentation also immer darum, den Schmerz beim Lesen möglichst gering zu halten. Der Schmerz ist dann gering, wenn: In den meisten Fällen gilt lediglich die generelle Grundanforderung an Dokumentation, dass sie die Kunden dazu befähigen muss, das Produkt vollständig und erfolgreich zu nutzen.

Zusätzlich können sich spezielle Erfordernisse basierend auf vertraglichen Vereinbarungen mit Kunden ergeben, oder aus besonders zugesicherten Eigenschaften. Wird zum Beispiel damit geworben, dass eine Software über eine spezielle Schnittstelle verfügt, dann muss diese Schnittstelle auch so dokumentiert sein, dass die Kunden sie erfolgreich verwenden können.

Insbesondere betrifft dies die Gestaltung von Warnhinweisen. Entwickler oder Technischer Redakteur? Ganz besonders gilt dies für Benutzerdokumentation.

Wer eine Software selbst programmiert, hat ganz automatisch eine ganz andere Sicht auf das Produkt als ein Benutzer. Die Benutzersicht einzunehmen, ist beim Schreiben von Benutzerdokumentation aber eine unbedingte Voraussetzung, wenn die Dokumentation wirklich gut werden und die Fragen der Benutzer widerspiegeln soll.

Sich als Entwickler aus der primär technischen Sichtweise zu lösen, ist unglaublich schwierig und gelingt nur in den seltensten Fällen. Technische Dokumentation, und damit auch Softwaredokumentation, professionell erstellen zu können, erfordert eine spezielle Ausbildung und auch ein gewisses Talent.

Hierfür gibt es heute eigenständige, mehrjährige Studiengänge. Zwar kann jeder schreiben, aber nicht jeder kann automatisch so schreiben, dass ihn jeder versteht!

Fazit Als Know-how-Lieferanten sind Entwickler unersetzlich. Allgemein lässt sich sagen: Je stärker eine Dokumentation auf die Benutzer der Software eingehen muss, desto eher sollte die Dokumentation NICHT von Entwicklern konzipiert und geschrieben werden, sondern von einem erfahrenen Technischen Redakteur.

Besonders effizient kann auch ein kombinierter Workflow zur Erstellung von Softwaredokumentation sein: Entwickler und Know-how-Träger stellen die wichtigen Fakten zusammen und schreiben eine erste Rohfassung der Dokumentation. In einem zweiten Schritt bereitet ein erfahrener Technischer Redakteur die Inhalte so auf, dass daraus eine auch für Kunden verständliche Softwaredokumentation entsteht. Besonders effizient ist dieses Modell deswegen, weil hierbei jeder genau das tut, was er am besten kann.

Best Practices für Softwaredokumentation. Wenn eine hochwertige, professionelle Softwaredokumentation entstehen soll, können Sie nicht erwarten, dass diese Dokumentation ein Entwickler ohne entsprechende Vorbildung mal eben nebenbei aus dem Ärmel schüttelt.

Wenn Sie keinen Technischen Redakteur einstellen können und keinen auf die Erstellung von Softwaredokumentation spezialisierten Dienstleister beauftragen möchten, bleibt nur eine Lösung: Lernen Sie uns kennen.

Sie möchten neue Wege einschlagen und sich bei SupplyOn bewerben? Hier lesen Sie, wer wir sind und was wir bieten. Aktuelles auf unserem LinkedIn-Kanal.

Ein Video sagt mehr als tausend Worte. Besuch im innovativen Werk für 3D-Druck: Webcast von der Bosch Connected World Produktionsmaterial in Echtzeit verfolgen Wissen, ob Ihr Produktionsmaterial pünktlich bei Ihnen ankommt - und ob es unbeschädigt ankommt. Erfolgreiche Unternehmen setzen auf SupplyOn. Unser weltweites Lieferantenmanagement ist mit SupplyOn sehr viel effizienter geworden.

SupplyOn ermöglicht es uns, mit überschaubarem Aufwand tausende von Lieferanten und Dienstleister in unsere digitale Welt zu integrieren.