Spec Writing Management

9

Ich kann mir einfach nicht vorstellen, Software ohne Spezifikation zu schreiben. Unabhängig davon, wie lückenhaft oder auf hohem Niveau es ist, ist es wichtig, den ahnungslosen Programmierern die Spezifikation zu erklären, welche Funktionen das Programm bietet.

Das Problem mit der Spezifikation ist jedoch, dass es sich während des gesamten Softwareentwicklungszyklus um einen Bürger zweiter Klasse handelt. Wenn die Entwicklung den Dampf aufnimmt, wird er vernachlässigt. Im Streitfall werden sich die Entwickler, Tester und Vertriebsmitarbeiter bemühen, die Spezifikation zu finden, die ihre Gründe rechtfertigt.

Es werden entweder ein oder mehrere Szenarien auftreten:

  1. Die Spezifikation kann nicht wiederhergestellt werden, niemand weiß, wo sich die Spezifikation befindet
  2. Verschiedene Versionen der Spezifikation stammen aus verschiedenen Quellen. es braucht große Schwierigkeiten, um herauszufinden , welche Version die aktuelle Version ist, oder ob es ist eine neueste Version verfügbar.
  3. Die Spezifikation ist unvollständig, einige Teile der Dokumente, auf die sie verweist, fehlen.

Daher ist das Spezifikationsmanagement wichtig, und es ist ebenso wichtig, dass jeder nur eine einzige Spezifikationsquelle hat.

Wie verwalten Sie Ihre Spezifikationen? Ich habe versucht, alle dazu zu bringen, Google Text & Tabellen zu verwenden, aber alle haben Einwände erhoben. Jeder ist einfach zu angetan und verliebt in Microsoft Word, das seiner Meinung nach sehr einfach zu verwenden ist, sehr einfach Bilder einzufügen, sehr einfach Gleichungen einzugeben und so weiter.

Wie kann man sie davon überzeugen, dass MS Word für das Teilen einfach schrecklich ist?

specifications Graviton
quelle

Antworten:

6

Wie kann man sie davon überzeugen, dass MS Word für das Teilen einfach schrecklich ist?

Verschwenden Sie nicht Ihre Zeit.

Zuerst. Die Spezifikation sollte (wirklich) im Klartext und unter Quellcodeverwaltung sein. Verwenden Sie Markdown oder RST oder ein anderes leichtes Markup-Tool, um eine PDF- oder HTML-Seite zu erstellen. Klartext.

Zweite. Nehmen Sie die verschiedenen Quellen. Füge sie zusammen. Schreiben Sie Ihr eigenes endgültiges Dokument.

Wenn sie Einwände erheben, haben sie zwei Möglichkeiten.

  1. Verwenden Sie Google Text & Tabellen (oder das Quellcodeverwaltungs-Tool), um Ihre Version zu bearbeiten .

  2. Senden Sie weiterhin Änderungen, die Sie bearbeiten, filtern und in das endgültige Dokument umwandeln.

Ich bevorzuge # 2. Jemand muss die Spezifikation "besitzen". Und eine Menge Leute (im Wiki-Stil) führen zu Debatten und Änderungskriegen und Nebendokumenten und Offline-Gesprächen und dergleichen.

S.Lott
quelle
1
+1 und erinnere dich an die Regel der geringsten Macht - Jeder, der eine ausgefallene Version in einem WYSIWYG-Editor haben möchte, kann einfach das gerenderte Markup kopieren.
10b0
@ l0b0: Netter Link.
S.Lott
6

Ich denke nicht, dass es sich um ein "Werkzeug" -Problem handelt, sondern um ein "Prozess" -Problem (oder ein Problemmangel).

Sie haben wahrscheinlich bereits einen Prozess zum Freigeben von Software (Komponententest, Integrationstest, Freigabeschreiben, Lieferung usw.). Sie müssen auch einen Dokumentationsprozess implementieren.

  • Wer wird die Spezifikationen schreiben? Wer wird sie aktualisieren oder warten?
  • Wer wird die Spezifikationen überprüfen?
  • Wer wird die Spezifikationen genehmigen? Architekt, Projektleiter, Qualitätssicherung?
  • Wie werden die Spezifikationen gespeichert?
  • Wer wird sicherstellen, dass keine veralteten Versionen verwendet werden?
Xavier T.
quelle
2
+1: Werkzeugprobleme sind häufig Symptome von Prozessproblemen.
S.Lott
Wir haben einen Prozess, aber die Leute beschweren sich einfach gerne darüber, dass der Prozess nicht funktioniert, und schneiden, wann immer möglich, Abstriche.
Graviton
@Graviton: Ihr Hauptproblem ist wahrscheinlich, dass das Management die Verwendung von Dokumentation nicht sehen kann und daher keine strengen Regeln durchsetzt. Wenn Sie möchten, dass sich die Dinge verbessern, müssen Sie ihnen wahrscheinlich zeigen, wie wichtig es ist.
Xavier T.
4

Eine Art von Kontrolle ist definitiv erforderlich.

Es muss versioniert und abgemeldet werden, und dieser Prozess muss streng sein.

An zu vielen Orten wird die Abmeldung vernachlässigt, was zu Brötchenkämpfen führt.

Der Ort spielt keine Rolle, solange er verfolgt werden kann

  • Sharepoint
  • ein sicheres, gesichertes freigegebenes Laufwerk
  • Ich habe einige Orte gesehen, die ihre Code-Quellcodeverwaltung verwenden !!

Noch wichtiger ist jedoch, dass Sie sich von allen Beteiligten und 1 oder 2 Personen, die dafür verantwortlich sind, einkaufen müssen, um sowohl das Dokument als auch die Abmeldung zu verwalten, z. der Projektmanager.

ozz
quelle
+1, Ich empfehle dringend, das Spezifikationsdokument in die Quellcodeverwaltung zu verschieben, wenn nichts anderes hilft. Ein Vorteil ist, dass Sie den Versionsverlauf erhalten. Auch wenn Sie keine Versionsunterschiede ausführen können (es sei denn, Sie finden ein Plugin, das Unterschiede in Word-Dateien ausführen kann), können Sie dennoch alle Versionen extrahieren und sehen, was geändert wurde. Dies kann bei Streitigkeiten über Spezifikationen SEHR nützlich sein. Die Abmeldung ist auch sehr gut zu haben. Und auch die Wichtigkeit, alle in den Prozess involviert zu haben (damit niemand sagen kann, wann das entschieden wurde?), Kann nicht genug betont werden.
FrustratedWithFormsDesigner
0

MS Word eignet sich perfekt zum Erstellen einer Spezifikation. Wir verwalten unsere in SharePoint, das auch die Versionierung übernimmt. Wenn Sie SharePoint oder ein anderes Dokumentverwaltungsprodukt nicht zur Hand haben, ist Google Text & Tabellen in Ordnung (Sie können jetzt DOC- / DOCX-Dateien hochladen, ohne sie in das Google Text & Tabellen-Format zu konvertieren). Oder wie andere vorgeschlagen haben, können Sie sie sogar in Ihrem Versionskontrollsystem für den Quellcode speichern (wenn die Personen, die die Spezifikationen erstellen, Zugriff auf dieses System haben).

Marcie
quelle
0 
 > How to convince them that MS Word is just terrible for sharing?

Sie können den Unterschied zweier Instanzen in einem Versionskontrollsystem nicht einfach vergleichen.

Aus diesem Grund mag ich keine Wortspezifikationen. Aber da es eine politische Entscheidung ist, Wortspezifikationen zu verwenden, haben wir als erste Seite "Verlaufsinformationen" mit diesen Spalten:

Versionsnummer (bezieht sich auf Produktüberprüfung), Autor, Datum, Beschreibung

k3b
quelle