Viele Software-Unternehmen, mit denen ich gearbeitet habe nicht über jede Art von
Prozess im Platz für das Tracking und die Verwaltung ihrer Software. In der Regel zwei oder
drei führen Entwickler der Software kontrolliert. Alle anderen mussten arbeiten
hinter ihnen zu aktualisieren oder zu integrieren, ihre einzelnen Bestandteile. Wie die
Projekte wuchs, wurde verwirrt Entwickler, die Verwaltung wurde frustriert, und
Schriftsteller beenden, denn es war schwer zu halten mit so vielen gleichzeitigen
Änderungen.

--- Was ist Software Configuration Management? ---

Der Zweck des Software Configuration Management (SCM) ist die Ermittlung der
Zustand und die Konfiguration eines Software-Projekts und die Möglichkeit zur Kontrolle Änderungen
zur Aufrechterhaltung der Integrität der Software, Rückverfolgbarkeit, und Rechenschaftspflicht
in der gesamten Software-Lebenszyklus. Das wichtigste Ziel von SCM ist es,
Kontrolle an den Entwicklungsprozess durch:

-- Zunehmende Entwicklung der Produktivität,
-- Unterstützung für eine bessere Kontrolle über das Projekt,
-- Unterstützung besser Projektmanagement,
-- Verringerung der Fehler und Bugs,
-- Unterstützung schneller Problem Identifizierung und Bug-Fixes,
-- Verbesserung der Kunden-oder Firmenwerte.

Ein Problem ist, dass eine einzige SCM-Lösung eignet sich nicht für alle Projekte.
Während die Kernkompetenzen SCM-Ziele und Funktionen bleiben die gleichen, das SCM-System
muss maßgeschneidert für jedes Projekt.

--- SCM-Prozess für das "Technical Writer ---

Viele Software-Projekte, die ich gesehen haben, verändert natürlich täglich. Eines Tages das Produkt
arbeitete ein Weg, am nächsten Tag wurde es komplett anders aus. Viele der
Schriftsteller in diesen Unternehmen ging aus der Tür murmelnd, dass "das Unternehmen
war nicht bereit für die Dokumentation. "

Eigentlich ist dies die Norm für viele neuere Software-Unternehmen, und Sie würden
überrascht, wie sie bereit sind, haben Sie da!

Bei der Arbeit an Software-Dokumentation, es ist wichtig, dass Sie entweder
in die SCM-Prozess, oder setzen ein, damit kann man immer haben
die jüngste Version der Software, mit denen zu arbeiten. Selbstverständlich haben Sie die
kann es sich nicht leisten zu verbringen Tag arbeitet an einer kompletten Prozess, in der Zwischenzeit
Zeit, werden nicht angenommen von dem Unternehmen. Allerdings kann man ein Stück des
Puzzle und verwenden Sie es zu Ihrem Vorteil.

Natürlich, einmal Entwicklung setzt ein Bit, haben Sie ein echtes Produkt
bei der Arbeit. Doch in der Zwischenzeit, haben Sie die Kern-Produkt, das Sie können
Einsatz in Ihre Aufgabe Analyse und Forschung. Dieser Schritt wird einzigen Ort, den Sie
Sprünge und Grenzen den Vorrang vor anderen Schriftstellern, aufgeben, weil der
ständig wechselnden Zustand eines Produkt!

Die allgemeinen Schritte eines SCM-Prozess sind im Folgenden
Unterabschnitten. Ihre Kenntnisse über diese Prozesse kann die Entwicklung
und der zu erbringenden Leistungen für jedes Software-Projekt!

* Source Code Versioning und Tracking

Source-Code-Versionierung und Verfolgung ist in der Regel durch irgendeine Art von
Quelle safeing Anwendung. Die Anwendung dient zur Speicherung und verfolgen
verschiedene Versionen des Quellcodes, damit Entwickler können ein
Archiv von Änderungen, ohne die Angst vor dem Verlust jeder Ebene der vorangegangenen Änderungen.

Quelle safeing Anwendungen speichern, jede neue Version des Kodex durch die Archivierung
die Unterschiede zwischen den vorherigen Versionen ergeben haben. Wenn Sie wollen zurück zu einem
frühere Version des Codes, die Anwendung Umbauten der ausgewählten Version
aus der Unterschiede.

Wenn Sie verfügen über zahlreiche Dateien in einem bestimmten Projekt, können Sie Tag eine Reihe von Dateien
mit einem symbolischen Namen. Dieser symbolische Name kann verwendet werden, um alle Dateien extrahieren
für eine Freisetzung oder Versions-Nummer, so dass Sie alle aktuellen Projekt
Dateien zusammen.

Die beliebtesten safeing-Source-Anwendungen sind die folgenden:

-- Visual Source Safe: http://msdn.microsoft.com/ssafe/Prodinfo/?RLD=25
-- PVCS: http://www.merant.com/products/pvcs/
-- RCS: http://www.componentsoftware.com/
-- CVS: http://www.cvshome.org/

Sie sollten Sprechen Sie den Systemadministrator, um sich Zugang, so dass Sie
Download des Codes. Nicht nur wird es dir gelingen, besser zu verstehen, was
Geschehen in der Anwendung durch das Lesen der Code, aber haben Sie Zugang zu den
verschiedene Header zu entwickeln, Application Programming Interface (API)
Referenzen nach Bedarf.

* Installations-Builds

Es ist die Verantwortung der Entwickler zu ermitteln und zu erwerben, alle Dateien
im Zusammenhang mit einem bestimmten Installation. Alle Dateien hochgeladen werden soll in die
Quelle sicheres System und markiert. Sobald ein neuer Tag erstellt wird, können Sie
Version auf eine Maschine bauen, und erstellen Sie eine neue Version des Produkts. In
einigen Fällen, diese Verantwortung wird aus einem Konfigurations-Manager,
Aber Ihr Zweck, für sich in der SCM-Prozess ist die Entwicklung
solide Dokumentation ... nicht verwalten die sichere Quelle.

Im Idealfall, als Teil eines SCM-Prozess, der Build-Prozess auftreten, sollte mindestens
einmal pro Woche. Es ist eine gute Idee zu einem Gespräch mit den Entwicklern, so dass sie benachrichtigen
Sie, wenn sie Tag ein neues Release. Auf diese Weise sind Sie erhalten ein komplettes
und up-to-date Reihe von Dateien für den Bau der meisten aktuellen Produktinformationen.

* QA

Qualität der Analyse und Untersuchung sind wichtige Teile des SCM-Prozess, da dies
ist, wo die Probleme gefunden werden und das Produkt bewertet werden kann, um zu sehen, wenn sie
entspricht den Standards und Anforderungen für das Projekt. Für Ihre Zwecke,
können eine Reihe von grundlegenden Tests durch die Schaffung einer Task-Analyse und eine einfache
Test Plan.

Die Task-Analyse bietet eine Reihe von Schritten, die ausgeführt werden müssen, um eine
spezifische Operation mit dem Produkt --- ebenfalls Teil der Dokumentation Analysis.
Es ist wichtig, dass die Task-Analyse durchgeführt werden zu allen größeren Update auf
die Software, um sicherzustellen, dass die Änderungen durchgeführt, um die
Dokumentation.
* Bug Tracking und Auflösung

Bug-Tracking und-beilegung sind nicht nur ein Teil der SCM-Prozess, sondern sind
auch mit Change Management. Es ist von wesentlicher Bedeutung, dass Bugs zu melden und
dass Entwickler sind über die Probleme zu gewährleisten Auflösung. Aber,
Lösung einen Fehler kann das Produkt in tiefere gefährdet, wenn in einigen
Fälle, die Auflösung führt eine Reihe von Fehlern sind.

Dies ist eine Funktion, wo Update-Dokument ins Spiel kommt. Immer, wenn ein Wechsel
Es wird auf die Software, um entweder einen Fehler beheben oder ändern Sie die
Funktionalität, die Update-Feature-Dokument hilft bei der Verfolgung der
Änderungen. Außerdem, Update-Funktion Dokumente können als Zusatz zum
die Unterlagen bis zum eigentlichen Inhalt aktualisiert werden können.

Einige der beliebtesten Bug-Tracking-und Management-Systeme sind wie folgt:

-- Teststrecke: http://www.seapine.com/
-- Mücken: http://sources.redhat.com/gnats/
-- Bug Wiser: http://www.hallogram.com/bugwiser/

Wie bewerten Sie das Produkt neu gebaut, die Übersicht über verschiedene Probleme, die Sie
Begegnung und berichten sie wieder zur Entwicklung leisten können. Auf diese Weise können Sie
ein Service für die Entwicklung Mitarbeiter als auch lernen, die verschiedenen Themen
im Zusammenhang mit der Ware selbst bestehen.

* Verpackung

Die Produkte sind verfügbar für die Freigabe vorgelegt werden sollte als abgeschlossen und getestet
Installation auf CD und über das Web. Für CD-Installationen, Dokumentation kann
werden im HTML-oder PDF-Format. Alle Anlagen sollten automatisch gestartet werden, wenn
eingefügt in das CD-Laufwerk gestartet werden, oder durch einen Doppelklick auf die Setup -
Anwendung.

Für Web-basierte Installationen, die grundlegende Informationen der Installation befindet sich
auf der Web-Seite an, die mit den angegebenen Download bereit. Sobald das Produkt
installiert wurde, kann der Nutzer lesen ausführliche Dokumentation aus einer HTML-oder PDF -
Datei.

Einige der beliebtesten Verpackungssysteme umfassen:

-- InstallShield: http://www.installshield.com/
-- Wise Solutions: http://www.wisesolutions.com/default.htm

* Deployment

Web-basierte Einsatz kann aus einer Web-Seite mit einem Link auf die
Installation ausführbar. Der Benutzer kann auf die Seite zuzugreifen, lesen Sie bitte die Anweisungen
für die Installation, dann klicken Sie bitte auf den Link zum Download.

CD-basierten Einsatz kann aus einer vollständigen Installation kopiert auf eine CD. Der
Benutzer kann Zugriff auf die CD, lesen Sie bitte die Anweisungen für die Installation von der
Online-Dokumentation, dann Manöver durch die Installation.

* Kunden-und Technischer Support

Alle Produkte kommen sollte mit einem User-Acceptance Test (UAT). Für benutzerdefinierte
Produkte, die UAT sorgt dafür, dass das Produkt ein minimaler Teil von
Anforderungen ursprünglich definierten Anforderungen an die Analyse-Dokument. Der
UAT ermöglicht es dem Benutzer, sich wohl fühlen, dass die Ware ihren Bedürfnissen entspricht
und Funktionen nach ihren Anforderungen. Für "Off-the-shelf Produkte,
UAT die sicherstellt, dass das Produkt-Setup richtig und Funktionen in der
Benutzer-Umgebung.

Kunden-und Support sind unerlässlich, dass, sobald das Produkt
in dem Gebiet und in Nutzung, die Bedürfnisse der Kunden gewisser Weise der Berichterstattung Bugs
das waren während verpassten QA. Es geschieht, sondern eine solide QS-Prozess sollte
Capture eine gute Prozentsatz der Probleme, vor dem Einsatz.

Zusätzlich hat der Kunde muss für den Zugriff auf einen Teil der Bug-Tracking
System zur Überwachung der Fortschritte auf ihrem Trouble Tickets. Das macht den Kunden
fühlen sich besser über das Produkt und den Prozess, wenn sie die Überprüfung des Status
über ihre Themen und Berichten.

--- Was kommt als nächstes? ---

Zahlreiche neue Software-Unternehmen haben nicht die Zeit oder die Lust auf ein
ordnungsgemäße SCM-Prozess vorhanden. Ein solcher Prozess nicht nur hilft bei der
Entwicklung, aber es hilft auch in der Dokumentation. In einer solchen Situation,
es ist wichtig, dass Sie verstehen die Grundlagen von SCM und diverse Software
Entwicklung Lebenszyklus. Nicht nur wird es dir gelingen, eine solide
von Dokumenten, aber Sie werden auch helfen, die Entwicklung einer soliden
Infrastruktur für das Unternehmen die Entwicklung Team!

Über den Autor
Edward B. Toupin ist ein freiberuflicher Berater, Schriftsteller, Autor und veröffentlicht
leben in Las Vegas mit seiner Sängerin / Schauspielerin Frau. Er derzeit Griffe
Technical Writing Aufgaben für verschiedene Unternehmen in New York, Chicago, und
Denver sowie imagineers und Märkte Feature-Länge Drehbücher.