Frage:
Soll ich meine Checklisten als Dokumentation einreichen?
Rarity
2012-04-13 21:04:52 UTC
view on stackexchange narkive permalink

Ich habe viele kleine Checklisten mit Aufgaben. Ich habe sie immer auf einem Notizblock aufbewahrt und die Seiten weggeworfen, als sie fertig waren. Jetzt verwende ich eine iPad-App, sodass mein Verlauf immer gespeichert ist, aber ich speichere ihn nicht in irgendeiner Form offizieller Dokumentation.

Ich bin Programmierer, daher wird der Großteil meiner Arbeit über die Versionskontrolle dokumentiert Aber es gibt viele kleine Korrekturen an nicht versionierter Software, Datenbankänderungen und Überprüfungen, die ich mache, wenn ich auch eine Art Support-Rolle ausfülle.

Wir haben versucht zu dokumentieren, was wir tun In meiner Abteilung kam mir eher die Idee, aber meine Änderungen haben nicht zu Problemen geführt.

Soll ich meine Aufgabenliste als eine Art offizielle Dokumentation aufbewahren? Wie würde ich sicherstellen, dass es tatsächlich für eine andere Person als mich nützlich ist?

Warum sollten Datenbankänderungen nicht in der Quellcodeverwaltung erfolgen? Und warum nicht Skripte einchecken, mit denen Sie Überprüfungen durchführen?
@HLGEM Ich arbeite daran, das in Gang zu bringen, aber es geht nicht nur um Datenbankmaterial
Sieben antworten:
#1
+8
Tech Lover in NYC
2012-04-14 09:00:07 UTC
view on stackexchange narkive permalink

Es hört sich so an, als würde Ihre Abteilung versuchen, besser zu verfolgen, wer was tut und was getan wird. Zu diesem Zweck würde ich ja sagen, Sie sollten sie behalten. Das heißt, es klingt so, als wären sie in dem Format, in dem sie sich befinden, für viele andere Menschen nicht nützlich, da es sich möglicherweise um zufällige Sammlungen großer und kleiner Aufgaben mit wenig zugehörigen Informationen oder Tags handelt.

Wenn vorhanden ist eine konzertierte Anstrengung in Ihrer Abteilung, mehr zu verfolgen und zu dokumentieren. Es scheint ein guter Zeitpunkt zu sein, Software dafür zu verwenden. Einer der großen Vorteile der Verwendung eines Dienstes wie Fogbugz, Teambox, Trello, Pivotal Tracker usw. besteht darin, dass alles, was Sie tun, sowohl für Sie selbst als auch für aktuelle oder zukünftige Teammitglieder durchsuchbar ist. Möchten Sie sehen, wann sich jemand zum ersten Mal mit einem bestimmten Problem befasst oder ob es häufig auftritt? Suchen Sie danach und sehen Sie, was auf Sie zukommt.

Ich persönlich habe Teambox an meinem Arbeitsplatz implementiert und ermutige meine Mitarbeiter, es für gemeinsame Aufgaben zu verwenden. Aber ich benutze es auch selbst für Dinge, die nur ich im Auge behalten muss, weil ich weiß, dass jeder, der in Zukunft in meiner Rolle ist (auch wenn ich es bin!), Diese Geschichte, wie bestimmte Dinge zuvor gehandhabt wurden, zu schätzen weiß.

Viele dieser Systeme sind relativ schnell und einfach zu verwenden und integrieren einen Kommentar-Stream, damit Aktualisierungen und Diskussionen rund um eine Aufgabe mit dieser Aufgabe gespeichert werden. Wenn es wiederholbare Aufgabenlisten gibt, können Sie diese auf vielen dieser Systeme als Vorlage speichern.

Verwenden Sie ein Ticketing-System (auch Issue Tracking genannt: wie Trello, Jira ... usw.).
#2
+6
Brandon
2012-04-13 21:59:26 UTC
view on stackexchange narkive permalink

Ich hatte bei meinem früheren Arbeitgeber die gleiche Situation. Ich fing gerade an, jedes Mal in unser Wiki zu schreiben, wenn ich ein neues, nicht triviales Support-Problem hatte, mit dem ich mich befassen musste. Es war etwas aufschlussreich, da es eine bedeutende Menge an Informationen gab, die ich gerade verinnerlicht hatte. Selbst die winzigen Probleme setzen wirklich voraus, dass Sie mindestens ein gewisses Maß an institutionellem Wissen haben.

Es ist mühsam, wenn Sie anfangen, aber danach ist es ein bisschen schön, wenn Sie Urlaub machen und vielleicht ein Telefon bekommen können Anruf statt 3-4 pro Tag. :)

Das klingt nach viel mehr als einer einfachen Checkliste.
Ich wünschte, wir hätten ein Wiki, ich mochte die Idee eines Wikis in einem Ticketsystem. Wir haben nur schrecklich sortierte Word-Dokumente
@FrustratedWithFormsDesigner Ja - mein tägliches Zeug könnte eine Checkliste für mich sein, aber es wird nicht für jemand anderen sein. Sie werden wahrscheinlich die halbe Seite mit Hintergrundinformationen benötigen, um zu erfahren, was los ist.
@Rarity Richten Sie eine ein. Installieren Sie IIS auf dem Entwicklungsserver, greifen Sie zum Windows Platform Installer, installieren Sie ScrewTurn und führen Sie es einfach aus. Ich bitte lieber um Vergebung als um Erlaubnis. :) :)
@Brandon Ich habe uns von Apache entfernt, um uns vom Windows Platform Installer fernzuhalten! Der Versuch, PHP von diesem Ding zu verwenden, war ein Albtraum ...
@Rarity Ich bin selbst ein Windows .NET-Typ, daher habe ich standardmäßig das WPI verwendet, aber ich verstehe, woher Sie kommen. Wirf MediaWiki auf eine Apache-Box und gehe in die Stadt. :) :)
#3
+3
voretaq7
2012-04-13 23:09:05 UTC
view on stackexchange narkive permalink

Ich würde sagen, Sie sollten alles dokumentieren, was Sie tun. Wenn die einzige Dokumentation die Checkliste ist, sollte sie irgendwie gespeichert werden.

Ein Hinweis zur Terminologie. Ich spreche jedoch nicht von "Dokumentation" im Sinne einer anderen Person, die später darauf verweist Ich spreche von einer Aufzeichnung Ihrer Aktivitäten, die Sie bei Ihrer Leistungsbeurteilung erwähnen können. Wenn Sie eine Liste Ihrer Aktivitäten führen, können Sie eine Leistungsbeschreibung zusammenstellen. Wenn Sie wichtige Ziele verfehlt haben, erhalten Sie eine Vorstellung davon, welche anderen Aufgaben die Ziele / Fristen verschoben haben. P. >

#4
+2
FrustratedWithFormsDesigner
2012-04-13 21:21:46 UTC
view on stackexchange narkive permalink

Vielleicht. Ich denke, der Ort, an dem sie am nützlichsten wären, wäre die Schulung des Personals, um neue Aufgaben zu übernehmen, mit denen sie nicht vertraut sind. Zum Beispiel kann die Fehlerbehebung bei einer bestimmten Problemklasse darin bestehen, einige Schritte durchzugehen und eine Checkliste zu verwenden, um bestimmte Situationen zu beseitigen. Eine Checkliste kann auch für Aufgaben wie komplizierte Codebereitstellungen oder Serveränderungen hilfreich sein. Ich habe einfache Checklisten in der Dokumentation für Entwickler-Setup-Anleitungen zum Einrichten der Umgebung für komplexere Projekte gesehen.

Der Nachteil einer Checkliste ist, wenn sich die Person, die ihr folgt, unwissentlich auf einer Instanz der Aufgabe befindet, die weicht ein wenig von dem ab, was die Checkliste annimmt. Hoffentlich geschieht dies jedoch erst, wenn die Person über die erforderlichen Kenntnisse verfügt, um die Checkliste nicht zu benötigen und ihre eigenen Entscheidungen zu treffen.

Sie möchten auch vermeiden, dass Personen vollständig von der Checkliste abhängig werden Machen Sie es nicht detailliert - schreiben Sie es möglicherweise eher als allgemeine Richtlinie, es sei denn, die spezifische Aufgabe ändert sich nicht und die detaillierten Details sind erforderlich.

Leider sind meine Checklisten mehr nur für mich, es würde einige wesentliche Änderungen erfordern, damit sie für andere nützlich sind. vor allem als etwas mehr als "was ich in letzter Zeit getan habe"
@Rarity: Sind sie zumindest wiederholbar, sodass Sie sie in Zukunft wieder verwenden können, um nicht alles noch einmal herausfinden zu müssen?
Noch nicht, sie sind normalerweise nicht in Unteraufgaben unterteilt. Wenn etwas wirklich kompliziert ist, schreibe ich es in ein aktuelles Dokument, wie zum Beispiel die Installation unseres Servers.
@Rarity: Nur nützlich für nicht wiederholbare Aufgaben ... Je nachdem, wie Sie sie beschreiben, können Sie möglicherweise mehr Nutzen daraus ziehen, wenn Sie Ihre Einkaufslisten als Dokumentation einreichen. Zumindest sind diese * manchmal * wiederholbar. ;)
#5
+1
IDrinkandIKnowThings
2012-04-13 23:50:23 UTC
view on stackexchange narkive permalink

Sie sollten die Richtlinien zur Aufbewahrung von Dokumenten in Ihrem Unternehmen überprüfen. Einige Unternehmen verlangen möglicherweise, dass Sie sie behalten, andere verlangen, dass Sie dies nicht tun. Der Grund dafür ist, dass sie nach einer gewissen Zeit als auffindbare Dokumente für Gerichtsverfahren angesehen werden können. Diese variieren je nach Unternehmen. Ich habe bei Unternehmen gearbeitet, die jedes Dokument über 5 Jahre als eine Aufzeichnung angesehen haben, die aufbewahrt werden musste. Auch wenn es sich um ein Menü zum Herausnehmen handelte, auf dem nicht gekritzelt war.

Aus Wikipedia

Die Aufbewahrungsdauer eines Dokuments ist ein Aspekt der Datensatzverwaltung. Es gibt den Zeitraum an, in dem ein Dokument sowohl elektronisch als auch in Papierform aufbewahrt oder "aufbewahrt" werden soll. Nach Ablauf der Aufbewahrungsfrist wird das Dokument in der Regel vernichtet. Der Begriff wird im Allgemeinen von Wirtschaftsprüfern und Steuerfachleuten verwendet, deren Beruf den Umgang mit Rechtsdokumenten umfasst, die nur für eine bestimmte Zeit bestehen bleiben müssen. Die Aufbewahrungsfrist variiert für verschiedene Arten von Datensätzen. Beispielsweise haben Gründungsdokumente eine dauerhafte Aufbewahrungsfrist (was bedeutet, dass sie aufbewahrt und niemals vernichtet werden sollten), aber Quittungen für steuerlich absetzbare Einkäufe eines einzelnen Steuerpflichtigen haben normalerweise eine Aufbewahrungsfrist von drei Jahren (und können häufig sicher verworfen werden nach diesem Zeitpunkt.) Die Länge der Aufbewahrungsfrist variiert je nach Branche und basiert auf der Wahrscheinlichkeit, dass das Dokument zu einem späteren Zeitpunkt aus Ligitationsgründen benötigt wird. Aufzeichnungen, die keinen weiteren Zweck erfüllen (abhängig von der Länge ihrer Aufbewahrungsdauer), werden aus Platzgründen, normalerweise von Aktenvernichtern, zerstört.

#6
+1
Reinstate Monica - Goodbye SE
2012-04-14 16:48:30 UTC
view on stackexchange narkive permalink

Um Ihre letzte Frage zuerst zu beantworten, wissen Sie nur, ob andere Personen interessiert sind, nachdem Sie sie an einer Stelle dokumentiert haben, die andere sehen können.

Mein Vorschlag: Dokumentieren Sie sie in einem Wiki, in dem jeder sie sehen kann. Sie können es entweder als "offizielles" Verfahren für Ihre Position auf eine Seite oder auf eine persönliche Seite setzen. Aber dann können zumindest andere Leute es sehen, wenn Sie weg sind und Ihre Aufgaben übernehmen. Und Mitarbeiter in ähnlichen Positionen im gesamten Unternehmen können es einer Peer-Review unterziehen und Ideen austauschen.

Der Schlüssel liegt darin, es öffentlich zu halten und einfach zu aktualisieren (und auch über Ihr iPad darauf zuzugreifen).

#7
  0
JohnFx
2012-04-13 23:38:37 UTC
view on stackexchange narkive permalink

Haben Sie ein Fallverfolgungssystem wie Bugzilla oder FogBugz? Ich arbeite in einem Programmierteam und wir verwenden unsere FogBugz-Instanzen für allgemeine Aufgaben zusätzlich zu Fehlern / Funktionsanforderungen und es funktioniert ziemlich gut.

Es ist ein kleines System und praktisch ein Ein-Mann-Team für eine bestimmte Lösung. Wir verwenden also keinen Bug-Tracker, sondern schreiben nur Nachrichten fest. War nicht groß genug, um andere dazu zu bringen, einen Bug-Tracker zu verwenden.
Eigentlich haben Sie dann vielleicht Glück. Mit FogBugz (und wahrscheinlich auch anderen) können Sie die gehostete Version ihres Tools kostenlos verwenden, wenn Sie weniger als 2 Benutzer haben (http://www.fogcreek.com/fogbugz/StudentAndStartup.html).


Diese Fragen und Antworten wurden automatisch aus der englischen Sprache übersetzt.Der ursprüngliche Inhalt ist auf stackexchange verfügbar. Wir danken ihm für die cc by-sa 3.0-Lizenz, unter der er vertrieben wird.
Loading...