Vor einigen Monaten habe ich eine Phase meiner beruflichen Laufbahn als mehrarmiger Shiva in einem Startup zur Entwicklung eines zerstörungsfreien Prüflabor-Managementsystems abgeschlossen. Ich werde Ihnen erzählen, wie ich einen Teil der Entwicklung im Zusammenhang mit dem Verbinden und Generieren von Dokumenten in ausreichendem Umfang für die weitere leise Nutzung des erstellten Systems für zwei Jahre dokumentieren konnte.
Ich werde versuchen, dem Leser so viel nützliches Material wie möglich zu geben und gleichzeitig die Interessen des Projekts zu beachten und die Nuancen der Implementierung und des internen Gebrauchs nicht offenzulegen.
Gegeben:
- cooles Entwicklungsteam und natürlich der Projektmanager. Zum Zeitpunkt des Projektstarts arbeitete ich als Art Director in einem der Studios in Tomsk und landete dann im Startup-Team
- Start mit Stahlbetonterminen für ein bestimmtes Ereignis - Beschleunigungsstart im FRII
- Erster Satz von Vorlagen aus mehr als 15 Dokumenten unterschiedlicher Größe von 1 Seite bis zu mehr als 100 Seiten in einem Dokument mit unterschiedlichen Verbindungsbedingungen
- Drittanbieterprojekt, das in eine zukünftige Lösung integriert werden soll
- Designer (Analyst, Designer, Designer, Art Director, Product Owner, Produktmanager in einem)
Herausforderung:
- Starten Sie ein Projekt pünktlich
- Sterben Sie das Team sechs Monate später nicht im Chaos, wenn Sie neue Funktionen und noch mehr Dokumentation im System verbinden (bei erfolgreichem Abschluss der Beschleunigung).
- mit der minimalen Anzahl von Briefen und dem Aufwand, um eine geeignete Dokumentation zu erreichen
- Entfremdung der Dokumentation an ein Team / einen Mitarbeiter, der nicht im Kontext steht
Ich muss sofort sagen, dass die folgenden Dokumentvorlagen ohne Methodik erstellt wurden. Ich habe mich ausschließlich an den Besonderheiten des Projekts, dem gesunden Menschenverstand und einer schrecklichen Frist orientiert.
Analyse und Vorbereitung
Ich hoffe, dass Sie jede nicht triviale Aufgabe mit der Analyse des Materials beginnen. In meinem Fall handelte es sich bei dem Material um Dokumentvorlagen und ein vorhandenes Projekt, in das eine Integration erforderlich war. Aber dann reden wir nur über Dokumente. Ich musste die Häufigkeit der Verwendung derselben Art von Daten innerhalb desselben Dokuments und zwischen Dokumenten bestimmen. Es war notwendig zu verstehen, ob gerade ein System benötigt wird oder ob Sie es schnell zuerst am Knie tun und dann mit dem Ergebnis umgehen können. Zu diesem Zeitpunkt wurde entschieden, dass das System benötigt wird, da fast alle Daten in dem einen oder anderen Band in einem Dokument und im gesamten Dokumentpaket wiederholt wurden - und dies ist ein sicheres Zeichen der Verwirrung bereits beim zweiten oder dritten Dokument beim Verbinden.
Der nächste Schritt besteht darin, den Zustand der Sauberkeit des Markups von Dokumenten zu verstehen. Ich werde es erklären. Tatsache ist, dass ich bereits ausgefüllte Dokumentvorlagen vom Methodiker erhalten habe - wer, wann und wie diese Dokumente kannte ich nicht, auch wenn ich wusste, dass dies wenig gegeben hätte. Das darin enthaltene DOCX-Dokument ist so etwas wie XML für Text, und einige Elemente sind in einem geöffneten Dokument möglicherweise nicht visuell sichtbar, befinden sich jedoch im Markup des Dokuments. Wie der Dokumentgenerator und verschiedene Software zum Anzeigen des Dokuments auf diese Markup-Elemente reagieren, ist nicht bekannt. Die Hauptwette war auf Microsoft Word, aber es gibt OpenOffice, LibreOffice und alle können unterschiedliche Ergebnisse liefern. Daher durchliefen alle Vorlagen zuerst den Stilbereinigungsvorgang - ein vollständiges Zurücksetzen aller Entwürfe und Neugestaltungen mit Dokumentstilen, wobei die Struktur des Dokuments angepasst wurde. Und auch nach diesem Vorgang haben wir nach der Generierung Probleme im Inhalt der Dokumente gesammelt. In Zukunft bin ich zu dem Schluss gekommen, dass es besser ist, das Dokument von Grund auf neu zu sortieren, wenn es klein ist, und die vom Methodiker bereitgestellte Vorlage nicht in Arbeit zu nehmen. Dies spart Zeit bei Dokumenten mit bis zu 5 Seiten. Niemand möchte dann nach dem Grund suchen, warum etwas passiert ist. Das Debuggen dieser Fälle ist für das Team äußerst mühsam. Wenn Sie über ein Paket von Dokumenten verfügen, gelangen Sie gleichzeitig zu einer einheitlichen Bildsprache.
Und da wir einen Ritus der Dokumentenbereinigung durchgeführt haben, bot sich das Osterei in Metainformationen an, weil die Leute gerne gute Dokumente teilen
Nach all den Arbeiten im Zusammenhang mit der Erstellung von Dokumenten habe ich Dokumente für die automatische Generierung markiert.
Markup von Dokumenten
Fragen Sie zu diesem Zeitpunkt die Entwickler nach dem variablen Format, das den von Ihrem Team ausgewählten Dokumentgenerator unterstützt, damit Sie ihn später nicht wiederholen müssen. Ich musste es wiederholen, aber dies war auf den Austausch des Generators zurückzuführen. Der neue Generator konnte nicht mit den Variablen im vorherigen Format arbeiten, aber die Fähigkeiten des neuen Generators erwiesen sich für uns als wichtiger und wir entschieden uns, ihn zu ersetzen.
Überprüfen Sie, ob genügend Informationen im System vorhanden sind, und stellen Sie fest, wie viele Daten für das Dokument nicht ausreichen. Wann sollen diese Daten auf dem System erscheinen? Wenn nicht genügend Daten für die Autarkie des Dokuments vorhanden sind, ist es besser, es zu verschieben. Was ist Dokumentenselbstversorgung? In meinem Fall gab es ein Dokument, das wir in drei Schritten fertiggestellt haben, das jedoch für ein bestimmtes Szenario sofort autark war, aber den Rest der Szenarien nicht abdeckte. Daher haben wir beschlossen, das Dokument für den Verkauf bereitzustellen, sodass der Benutzer leere Zellen für nicht abgedeckte Szenarien ausfüllen konnte. und anschließend das Dokument mit dem Erscheinungsbild der erforderlichen Funktionalität abgeschlossen.
Variablen- und Schnittstellendokumentation
Zu Beginn der Notiz schrieb ich, dass wir streng auf ein bestimmtes Ereignis beschränkt waren. Außerdem hatte ich schon einen Urlaub geplant. Wenn ich nicht verfügbar war, aber dringend eine Systemvariable hinzufügen musste (nicht in der Endbenutzeroberfläche verfügbar), fügten die Entwickler die Zeile mit der Variablen selbst hinzu und fügten dann die fehlenden Bedingungen hinzu. In dieser Hinsicht gibt die Spezifikation von Variablen nicht vor, korrekt und ideal zu sein, sondern ist ein ziemlich funktionierendes Dokument, das anschließend erweitert und weiterentwickelt wurde. Die Hauptregisterkarte im Dokument hat sich von Anfang an und zum Zeitpunkt meines Ausscheidens aus dem Projekt nicht strukturell geändert.
Vorlage „
Spezifikationen für diese Felder “, die Sie für Ihre Arbeit verwenden können. In dem Dokument habe ich einen Teil der Daten für ein Beispiel hinterlassen. Diese Vorlage eignet sich möglicherweise zur Dokumentation der Benutzeroberfläche, um die Entwicklungsqualität zu steuern. Zum Beispiel weiß ein Produktbesitzer, welches Mindestergebnis er erhalten wird, ein Entwickler versteht anhand der Aufgabenbeschreibung + Spezifikation dieser Felder genau, welches Minimum zu tun ist, und wenn etwas fehlt, wird der Testingenieur offensichtliche Fälle erkennen. Am Ende schreibt alles schwarze Zahlen.
Zuerst dauert das Dokument eine beträchtliche Anzahl von Stunden, aber dann sparen Sie viel Zeit, und die Aktualisierung dauert gelegentlich buchstäblich Minuten.
Inhalt:
- Die Seite ist eine Anleitung für eine Person außerhalb des Projektkontexts, wo sie suchen muss. Nützlich für ein neues Mitglied in einem Team oder für das Outsourcing eines Projekts.
- Feldname
- Feldtyp
- Pflichtfeld in Projekten (ich erinnere Sie daran, wir hatten eine Datenbank eines anderen Projekts) - eine Markierung zum Synchronisieren der Anforderung der Bindung zwischen dem Dokument und der Schnittstelle. Wenn die Informationen im Dokument verbindlich sind und das System sie nicht auf andere Weise empfangen kann, muss dieses Feld in der Schnittstelle obligatorisch sein
- Feldmaske - Das Format für die Aufzeichnung von Informationen ist in der behördlichen Dokumentation klar definiert.
- Standardwert
- Die maximale Anzahl von Zeichen im Feld
- Feldskalierbarkeit (abhängig von der Auflösung) - Beschreibung des Verhaltens eines Schnittstellenelements in Abhängigkeit von der Auflösung
- Datenanforderung - Welche Interaktion ist mit dem Schnittstellenelement zulässig und was kann eintreten?
- Erfolgreiche Probe
- Platzhalter - Tooltip für Benutzer innerhalb des Schnittstellenelements
- Anpassung des Feldes - nicht standardmäßige Schnittstellenelemente oder abgeschlossene Aufgaben
- Zusätzliche Informationen neben dem Feld - Wenn auf den Platzhalter aufgrund der Textmenge nicht verzichtet werden kann, verwenden wir einen Tooltip oder ein Handle
- Validierungstyp
- Validierungsnachricht - Systembedingungen und Antwort
- Variable in Dokumentvorlagen - Was wird in die Dokumentvorlage eingefügt?
- Link zur Seite - wurde nicht verwendet
- Position des Feldes in der Schnittstelle - wurde daher nicht verwendet
Dokumentverbindungsdokumentation
Um das Dokument vom Endbenutzer zu erhalten, reicht es nicht aus, es zu bearbeiten und zu markieren. Das Dokument muss noch korrekt verbunden sein. Es ist besonders wichtig, wenn Sie dieselbe Vorlage haben, die je nach den Bedingungen ihren Inhalt ändert. Dafür habe ich ein separates Dokument verwendet.
Vorlage "
Dokumentverbindung ", ich hoffe, dass es für jemanden nützlich ist.
Inhalt:
- Status - Zeigt den aktuellen Status des Dokuments im System an. Wir haben ein Dokument in drei Schritten verbunden. Der Status des Dokuments lautete "Finalisieren".
- Dokument - Der Name des Dokuments innerhalb des Teams, der Wissensdatenbank und innerhalb unseres Dokumentations- und Aufgabeneinstellungssystems
- Typ
- Das Format des Dokuments ist, wenn dasselbe Dokument in verschiedenen Vorlagen vorliegen kann, abhängig von der behördlichen und technischen Dokumentation, der dieses Dokument entspricht
- Bildung - Ein Dokument kann nur eine Vorlage sein, in die Variablen einfach eingesetzt werden, oder aus einer Vorlage mit 3 Seiten können Sie Dokumente mit mehr als 100 Seiten erhalten - dynamische Dokumente
- Das Vorhandensein im Paket ist eine Funktion des Systems. Sie können ein Dokumentpaket erhalten oder Dokumente separat herunterladen
- Anwesenheitsbedingung - das Vorhandensein eines bestimmten Dokuments in der Verpackung
- Die Verbindungsfunktion ist der Teil des Dokuments, der nicht in der Vorlage enthalten ist und durch den Code geregelt wird.
- Link zur zu verbindenden Datei
- Separat herunterladen
- Der Name der herunterzuladenden Datei - Ein Dokument im System kann beliebig aufgerufen werden, der Endbenutzer muss jedoch beim Herunterladen einen bestimmten Namen sehen
Insgesamt
Infolgedessen habe ich in beiden Dokumenten 362 Zeilen ausgefüllt. Beeindruckende Lautstärke? Tatsächlich handelt es sich jedoch um mehr als 30 Dokumentvorlagen, und in zwei Jahren (1 bis 1,5 Wochen) werden insgesamt 40 bis 60 Stunden Arbeit einer Person aufgewendet, ohne die Bearbeitung der Vorlagen selbst und den Wortlaut der Verbindungsaufgaben.
Das Projekt hat die Beschleunigung im IIDF erfolgreich bestanden und wurde zu einem eigenen Entwicklungsteam. Dank der vorhandenen Dokumentation mussten sich die neuen Teammitglieder nicht lange mit dem befassen, was vor ihnen in Bezug auf die Erstellung von Dokumenten getan wurde. Alle Teammitglieder hatten jederzeit Zugriff auf den aktuellen Status der verbundenen Dokumente.
Die Hauptphasen in der Dokumentation des Dokumentenerstellungsprozesses:
- Analyse des Inhalts von Dokumenten
- Dokumentenhygiene
- Korrigieren Sie Variablen parallel zum Dokument-Markup
- Korrigieren Sie die Nuancen beim Verbinden von Dokumentvorlagen.
Danke, dass du bis zum Ende gekommen bist.