Ich habe festgestellt, dass JEDE Dokumentation besser ist als KEINE Dokumentation. Die angemessene Menge hängt normalerweise davon ab, wie viel Zeit wir dafür benötigen oder wie sehr wir Support-Telefonanrufe und E-Mails hassen.
Es scheint, dass Ihre derzeitigen Teammitglieder einige unrealistische Erwartungen an ihre Erinnerungen haben oder sich für ihre Schreibfähigkeiten schämen und nicht bereit sind, zu üben.
Mir ist klar, dass ich hier in einer Minderheit bin (englischer Major, der in der Graduiertenschule in die Softwareentwicklung eingestiegen ist), da ich Dokumentation nicht als lästige Pflicht empfinde. Es ist ein wertvolles professionelles Werkzeug. Ich finde das Schreiben vielleicht nicht so schwierig wie einige meiner Kollegen, aber das liegt hauptsächlich daran, dass ich mehr Übung darin habe. Ich halte ein Projekt nicht für abgeschlossen, es sei denn, es enthält Dokumentation, und ich schreibe es normalerweise aus rein egoistischen Gründen: So kann ich den Leuten etwas zum Lesen geben, anstatt Anrufe und E-Mails anzunehmen, oder ich kann mich daran erinnern, worüber wir zuletzt gesprochen haben Monat oder so kann ich mich darauf beziehen, wie ich etwas getan habe, wenn ich es mitten in der Nacht unterstützen muss.
Der beste Weg, sich der Dokumentation zu nähern, besteht darin, sie so zu schreiben, wie Sie es möchten, genau wie das Schreiben von Testcode. Es ist erstaunlich, wie einige vorab geschriebene Vorlagen (mit Kopfzeilen, Codestubs usw.) die Dokumentation einfacher und schneller machen können. Auf diese Weise können Sie Änderungen erfassen, wenn dies geschieht, und Sie haben im Laufe der Zeit weniger Boden, den Sie abdecken müssen. Auf diese Weise sind Sie effizienter, da Sie bei Bedarf auf die Dokumentation zugreifen und diese auf dem Weg ändern können. Wenn Sie dies beispielsweise in einem Wiki tun, werden Aktualisierungen einfacher, und Sie können Probleme mit der Dokumentversion vermeiden, wenn die neueste und beste Version immer am selben Ort online ist, und Sie können einfach Links an Personen senden, die sie lesen müssen.
Wenn Sie ein wenig Zeit mit Dokumentieren verbringen, werden Sie ALLE schneller arbeiten, insbesondere wenn jemand Neues dem Team beitritt, da er nicht die ganze Zeit damit verbringen muss, alles herauszufinden. Das Herausfinden von Dingen macht Spaß, aber es macht keinen Spaß, wenn Sie es eilig haben, um die Produktion zu reparieren. Wir würden alle viel Zeit sparen, wenn wir alle noch ein paar Notizen schreiben würden.
Hat Ihr Team dieselben Probleme beim Testen oder Schreiben von Testcode? Wenn nicht, ist dies ein einfacher Verkauf.
Ihre Dokumentation ist in vielerlei Hinsicht nützlich:
1) Für Sie und Ihre Mitarbeiter, während Sie an dem Projekt arbeiten.
2) An Ihre Kunden. Eine Dokumentation (einschließlich Diagramme), die Sie Benutzern zeigen können, erleichtert Diskussionen in Besprechungen, insbesondere wenn Sie über komplizierte Systeme sprechen. Auch wenn die Dokumentation unvollständig ist, ist dies ein Ausgangspunkt.
3) An die Menschen, die Ihre Arbeit erben werden (in drei Jahren können Sie es sogar sein). Viele meiner jüngeren Mitarbeiter denken, dass sie sich für immer an Dinge erinnern werden. Ich weiß, ich werde mich nach dieser Woche nicht mehr daran erinnern, wenn ich es nicht aufschreibe. Wenn Sie über eine Dokumentation verfügen, müssen Sie keinen halben Tag damit verbringen, sich daran zu erinnern, wie Sie etwas strukturiert haben, und alles erneut herausfinden.
4) Für Sie und andere, wenn die Situation politisch oder umstritten wird. Als jemand, der sich in Besprechungen Notizen macht, um wach zu bleiben und Langeweile zu bekämpfen, war ich oft der einzige mit der schriftlichen Version einer Entscheidung. Die Person, die es aufgeschrieben hat, gewinnt den Streit. Erinnern Sie sich daran, wenn jemand das nächste Mal sagt: "Erinnern Sie sich an das Treffen, das wir im vergangenen Winter im Konferenzraum 4 hatten, als wir über X gingen? Fred war da, und wer ist dieser Typ aus dem Rechnungswesen?"