|
Autor
|
Thema: Erfahrungsaustausch zu technischen Dokumentationen (2185 mal gelesen)
|
telenoise
Mitglied
Anwendungsentwickler
   Beiträge: 10
Registriert: 27.07.2008
|
erstellt am: 27. Jul. 2008 13:46  <-- editieren / zitieren -->   Unities abgeben:          
Wir sind zwar selbst ein Softwarehaus und stellen software her, aber es ist auch sehr interessant einmal den Bedarf der Benutzer zu hören. Deshalb möchte ich hier gerne diesen Thread aufmachen. Wir beschäftigen und mit unserer Software Fast-Help.de mit Dokumentationen im Single Source Prinzip.
Diese Software ist ähnlich dem Programm RoboHelp ( Macromedia / Adobe ) und erstellt Hilfedateien im Format
CHM, HLP, PDF, HTML, RTF, wxWidgets... etc. Nun zur eigenlichen Frage für den Thread: Welche Anforderungen hat die CAD Branche an eine Dokumentation ? Grundsätzliche Informationen zum Thema und auch zu unseren Mitbewerbern
finden Sie in einer Ausgabe der Microsoft MSDN .
http://msdn.microsoft.com/de-de/magazine/cc163549(en-us).aspx Bitte versteht diesen Thread als Informationsthread.
Wir werden diese Informationen für unsere Produkt-weiterentwicklung verwenden und
suchen hierüber den Kontakt zu den Usern. Eine Antwort auf diesen Beitrag verfassen (mit Zitat/Zitat des Beitrags) IP |
Starsky
Mitglied
Informatiker / Plossys Admin
Beiträge: 2
Registriert: 15.06.2005
|
erstellt am: 22. Sep. 2008 11:42 <-- editieren / zitieren --> Unities abgeben: Nur für telenoise 
Zitat:
Welche Anforderungen hat die CAD Branche an eine Dokumentation ?
Nachdem die technische Zeichnung ja eine Dokumentation ist, ist die Frage ist ganz einfach zu beantworten.
Alles was technisch machbar ist (2D genauso wie 3D).
d.h. Zeichnungen in Farbe zusätzlich zu den üblichen DIN-Formaten mit derzeit 34" Breite und 30/40m länge. Möglichst noch im Format 1:1 - also 10mm auf dem Papier sind auch 10mm am Teil. Farben sind als Echtfarben darzustellen. Am Bildschirm genauso wie auf dem Papier. Ach ja und das ganze darf in der max. möglichen Größe nicht länger als 1-2 sek auf dem Bildschirm und nach Möglichkeit auch beim Druck nicht länger brauchen.
Ein paar kleine Einschränkungen bezüglich der Farbentreue und der Zeit lassen sich verschmerzen, wenns nicht zu sehr ausartet.
Zum Datenaustausch sollen natürlich genormte Formate vorhaden sein. Ebenso zur Ablage (Produkthaftung bis zu 100 Jahre) inkl. dezidierter Freigabeabläufe Ich glaube allerdings nicht, das es das ist, worauf du hinaus willst.
Eher welche Anforderung an die Dokumentation des CAD-Systems gestellt werden.
Das wäre dann: Einfach, leicht Verständlich. viele bunte Bilder die das System erklären mit sinnvollen Beispielen die auch funktionieren. [Diese Nachricht wurde von Starsky am 22. Sep. 2008 editiert.] Eine Antwort auf diesen Beitrag verfassen (mit Zitat/Zitat des Beitrags) IP |
highway45
Ehrenmitglied V.I.P. h.c.
Bastler mit Diplom
Beiträge: 6387
Registriert: 14.12.2004 CoCreate OSD und irgendein Windows Gedöns
|
erstellt am: 22. Sep. 2008 12:12 <-- editieren / zitieren --> Unities abgeben: Nur für telenoise
Ich weiß kein Punkt, der speziell auf CAD zutreffen könnte. Folgende Dinge fallen mir allgemein ein: Wichtig ist, in der Dokumentation nach Stichwörtern suchen zu können.
Dabei sollten auch ähnliche Begriffe gefunden werden.
Beispiel olilinie findet auch polyline. Auf den einzelnen Seiten sollte auch noch mal gesucht werden können, beispielweise mit Strg+F. Gut finde ich die Möglichkeit, bestimmte Seiten als Favoriten abzuspeichern. Hilfreich sind auch jede Menge kreuz- und quer-Verweise. Die Dokumentation sollte in Muttersprache des Anwenders geschrieben sein. In einem Forum sollte der Link der Seite angegeben werden können, also nicht die Überschrift, sondern die tatsächliche Datei der Seite.
Beispiel: kuckst du Hilfe Seite ../doc/page14#chapter3 ------------------
 CoCreate: Hilfeseite I FAQ I Hilfreiche Links Eine Antwort auf diesen Beitrag verfassen (mit Zitat/Zitat des Beitrags) IP |
Ex-Mitglied
|
erstellt am: 14. Jan. 2009 17:14 <-- editieren / zitieren -->
<SNIP>
So viel Werbung auf einmal? Das muss ja wohl nicht sein ....
</SNIP> |
| | Lichtplaner Projekt, Fachplaner Licht, Innenarchitekt, TGA-Planer (m/w/d) | | Molto Luce kurz gefasst. Molto Luce ist Spezialist für innovative Beleuchtungslösungen - und zwar seit vielen Jahren. Als international agierendes Unternehmen entwickeln und produzieren wir designorientierte Leuchten und planen funktionale Konzepte für beste Lichtatmosphäre und -wirkung. Unser Know-how kommt in Projekten von Hotellerie & Gastronomie, Retail, Office & Corporate Architecture, Healthcare oder dem privaten Wohnraum zur Anwendung.... | | Anzeige ansehen | Feste Anstellung |
|
mahabharata
Mitglied
Techn.Redakteur, Terminologie
Beiträge: 10
Registriert: 25.09.2009
|
erstellt am: 25. Sep. 2009 10:20 <-- editieren / zitieren --> Unities abgeben: Nur für telenoise
Zitat: Welche Anforderungen hat die CADBranche an eine Dokumentation? Ich habe zwar keine Ahnung, ob dieser Thread noch aktuell ist (vermutlich nicht, in Anbetracht der letzten Einträge), aber meinen Senf werde ich trotzdem dazu abgeben, in der Hoffnung auf einen WissensAustausch. Ich bin Techn.Redakteurin, zwar nicht im Software-Bereich, sondern im Maschinenbau, kann aber zumindestens zum Inhalt ein paar Anregungen geben.
Ich stimme @highway45 in vielen Punkten zu, zB. Stichwörtersuche, die Möglichkeit, Seiten als Favoriten abzuspeichern und dass die Dokumentation auch in der Muttersprache des Anwenders geschrieben sein soll/ muss. Die Nummer mit den Kreuz- und QuerVerweisen find ich nicht gut, stiftet nur heillose Verwirrung und irgendwann kennt man sich nimmer aus. Sollte meiner Meinung nach im Zuge der Suche eher in Form einer guten Klassifikation stattfinden. Ein ziemlich arbeitsintensives Unterfangen, das sich aber auf viele Bereiche positiv auswirkt.
Eine Antwort auf diesen Beitrag verfassen (mit Zitat/Zitat des Beitrags) IP |
| Anzeige.:
Anzeige: (Infos zum Werbeplatz >>)
 |
Foren auf CAD.de
| 
