Dokumentation ist ein Begriff mit vielen Bedeutungen, von denen die allgemeinste sind:

• Eine Reihe von Dokumenten, die auf Papier, oder online, oder auf digitalen oder analogen Medien, wie Audioband oder CDs zur Verfügung gestellt ist.
• Der Prozess, Kenntnisse, als in wissenschaftlichen Artikeln zu dokumentieren.
• Der Prozess, Beweise zur Verfügung zu stellen.
• Das Schreiben der Produktdokumentation, wie Softwaredokumentation.
• Ein Synonym für den Begriff Dokument.
• Ein Synonym für den Begriff Bibliografie.
• Ein Studienfach und ein Beruf, der von Paul Otlet (1868-1944) und Henri La Fontaine (1854-1943) gegründet ist, der auch genannte Dokumentationswissenschaft ist. In diesem Feld erzogene Fachleuten werden documentalists genannt. Dieses Feld hat seinen Namen in die Informationswissenschaft 1968 geändert, aber etwas Gebrauch des Begriffes Dokumentation besteht noch, und es hat Anstrengungen gegeben, den Begriff Dokumentation als ein Studienfach wiedereinzuführen.

Dokumentationsgelassenheit

Dokumentation kann einschließen

• schriftliche Information für irgendwelchen gelesen, Vorsprung oder das technische Durchführen,
• Datenmedien jedes Formats und für jede Fortpflanzung,
• anderer Inhalt.

Allgemeine Typen der Dokumentation schließen Benutzerhandbücher, technische Dokumentation, Direkthilfe, Führer der schnellen Verweisung ein. Es ist weniger üblich, Hardcopy (Papier) Dokumentation zu sehen. Dokumentation wird über Websites, Softwareprodukte und andere Online-Anwendungen verteilt.

Grundsätze, um Dokumentation zu erzeugen

Während vereinigt, sind ISO Standards öffentlich nicht leicht verfügbar, ein Führer von anderen Quellen für dieses Thema kann dem Zweck dienen. David Berger hat mehrere Grundsätze des Dokumentenschreibens, bezüglich der Begriffe gebraucht, Verfahren numerierend und sogar Längen von Sätzen usw. zur Verfügung gestellt.

Richtlinien

Der folgende ist eine Liste von Führern, die sich mit jedem spezifischen Feld und Typ befassen:

• Dokumentation in der Gesundheitsfürsorge
• These, schreibend
• Papiere für das akademische Zeitschriftenveröffentlichen (d. h. Zeitschrift der Nahrungsmittelwissenschaft und Analytischen Chemie)

Verfahren und Techniken

Die Verfahren der Dokumentation ändern sich von einem Sektor oder einem Typ, zu einem anderen. Im Allgemeinen können diese das Dokumentenzeichnen, die Formatierung, das Einreichen, die Prüfung, das Genehmigen, das Verteilen, das Wiederpostulieren und das Verfolgen usw. einschließen, und werden durch verbundene EINGETUNKTE BISSEN in einer Durchführungsindustrie einberufen.

Das Produzieren der Dokumentation

Technische Redakteure und korporative Mitteilende sind Fachleuten, deren Feld und Arbeit Dokumentation sind. Ideal haben technische Redakteure einen Hintergrund sowohl im Gegenstand als in auch im Schreiben und Betriebsinhalt (Informationsarchitektur). Technische Redakteure arbeiten allgemeiner mit Gegenstand-Experten (SMEs), wie Ingenieure, medizinische Fachleuten oder andere Typen von Kunden zusammen, um dann Inhalt (Dokumentation) zu definieren und zu schaffen, die den Bedarf des Benutzers deckt. Korporative Kommunikationen schließen andere Typen der schriftlichen Dokumentation ein, die für die meisten Gesellschaften erforderlich ist.

Spezialisierung der Dokumentation

• Marktkommunikationen (MarCom): Schriftsteller von MarCom sind bestrebt, den Wertvorschlag der Gesellschaft durch eine Vielfalt des Drucks, elektronischer und sozialer Medien zu befördern. Dieses Gebiet des korporativen Schreibens ist häufig mit der Reaktion zu Vorschlägen beschäftigt.
• Technische Kommunikation (TechCom): Technische Redakteure dokumentieren ein Projekt oder Dienst einer Gesellschaft. Technische Veröffentlichung schließt Benutzerhandbücher, Installationshandbücher und Verfahren der Fehlerbeseitigung/Reparatur/ersetzen ein.
• Das gesetzliche Schreiben: Dieser Typ der Dokumentation ist häufig von Rechtsanwälten oder paralegals bereit, wer in der privaten Praxis oder behalten als korporativer Rat sein konnte.
• Gehorsam-Dokumentation: Dieser Typ der Dokumentation kodifiziert Standardbetriebsverfahren (EINGETUNKTE BISSEN), für irgendwelche Durchführungsgehorsam-Bedürfnisse, bezüglich Sicherheitsbilligung, Besteuerung, Finanzierung, technischer Billigung usw.

Das Indexieren

• Index (Datenbank)
• Index (suchen Motor)

Dokumentation in der Informatik

Der folgende ist typische Dokumentationstypen

• Bitte um den Vorschlag (RFP)
• Voraussetzungen / Behauptung der Arbeit / Spielraum der Arbeit (SOW)
• Softwaredesign und funktionelle Spezifizierung
• Systemdesign und funktionelle Spezifizierungen
• Änderungsverwaltung, Fehler und Erhöhung, die verfolgt
• Benutzertest und Annahme (UTA)

Dokumentation schließt wie Durchführbarkeitsbericht, Entwicklerdokumentation, betriebliche Dokumentation, Logbuch und usw. ein

Werkzeuge, um Software zu dokumentieren

Es gibt viele Typen der Software, und Anwendungen haben gepflegt, Dokumentation zu schaffen.

SOFTWARE DOCUMENTATION FOLDER (SDF)

Ein allgemeiner Typ des Softwaredokumentes, das von Softwareingenieuren in der Simulierungsindustrie geschrieben ist, ist der SDF. Wenn er Software für einen Simulator entwickelt, der sich von eingebetteten Avionik-Geräten bis 3D-Terrain-Datenbanken über volle Bewegungsregelsysteme erstrecken kann, behält der Ingenieur ein Notizbuch, das über die Entwicklung "das Bauen" des Projektes oder Moduls ausführlich berichtet. Das Dokument kann eine wiki Seite, Dokument von MS Word oder andere Umgebung sein. Sie sollten eine Voraussetzungsabteilung, eine Schnittstelle-Abteilung enthalten, um über die Nachrichtenschnittstelle der Software ausführlich zu berichten. Häufig wird eine Zeichen-Abteilung verwendet, um über den Beweis des Konzepts ausführlich zu berichten, und dann Fehler und Erhöhungen zu verfolgen. Schließlich, eine Probeabteilung zum Dokument, wie die Software geprüft wurde. Diese Dokumentenübereinstimmung zu den Voraussetzungen des Kunden. Das Ergebnis ist ein Detaillieren dessen, wie die Software entworfen wird, wie man baut und die Software auf dem Zielgerät, und irgendwelche bekannten Defekte und Arbeits-Arounds installiert. Das baut Dokument ermöglicht zukünftigen Entwicklern und maintainers, Geschwindigkeit auf der Software auf eine rechtzeitige Weise zu erreichen, und stellt auch einen Fahrplan dem Ändern des Codes oder Suchen nach Programmfehlern zur Verfügung.

Dokumentation im Strafrecht

"Dokumentation" ist der bevorzugte Begriff für den Prozess, kriminelle Datenbanken zu bevölkern. Beispiele schließen die Terroristenidentität des Nationalen Anti-Terrorzentrums Datamart Umgebung ("GEZEITEN"), Sexualübertreter-Registrierungen und Bande-Datenbanken ein.

Zeichen

Siehe auch

• Authoring
• Bibliografische Kontrolle
• Änderungskontrolle
• Zitat-Index
• Copyright

Beschreibung

• Dokument
• Dokumentation (Feld)
• Dokumentenbezeichner
• Dokumentenverwaltungssystem
• Dokumentarfilm
• Freiheit der Information
• Wörterverzeichnis
• Historisches Dokument
• Index, der (veröffentlicht)
• ISO 690
• ISO 5964
• ISO 9001
• Internationale bibliografische Standardbeschreibung
• Das Genehmigen
• Liste des Inhalts
• Handbuch
• Medizinisches Zertifikat
• Das Veröffentlichen
• Rekordmanagement
• Stil-Führer
• Technische Kommunikation

Links

• IEEE Berufsnachrichtengesellschaft

• Dokumentationsdefinition durch das Linux Informationsprojekt (LINFO)

• Information & Dokumentationsliste von ausgewählten Werkzeugen
• Besuch für den Prozess & die Produktdokumente, Anweisungen Schreibend: Ein Experte im Technischen Schreiben-Experten Seit 2004
• Bibliothek von Artikeln über die Dokumentation: Das Technische Schreiben und die Dokumentationsartikel