Als «documentation» getaggte Fragen

Die Softwaredokumentation ist geschriebener Text, der der Computersoftware beiliegt. Es wird erklärt, wie die Software funktioniert, wie sie installiert wird, wie sie verwendet wird und andere Hilfsmittel.

2
Allgegenwärtige Sprache - Konflikt zwischen Korrektheit und Benutzerfreundlichkeit
Ein zentraler Bestandteil von Domain Driven Design ist die konsistente Verwendung einer allgegenwärtigen Sprache im gesamten System - in Konversationen, Code, Datenbankschema, Benutzeroberfläche, Tests usw. Ich bin an einem Projekt beteiligt, in dem es bereits eine etablierte Domain-Sprache gibt, die von einer internationalen Standardorganisation definiert wird. Wir arbeiten jedoch für …
13
Können Sie eine eindeutige Spezifikation in einer natürlichen Sprache wie Englisch schreiben?
Es scheint mir, dass Sie unmöglich eine Softwarespezifikation in Englisch schreiben können, die völlig frei von Mehrdeutigkeiten ist, einfach aufgrund des informellen Charakters der natürlichen Sprache - und daher muss eine wirklich eindeutige Spezifikation Code enthalten, der in einer formal spezifizierten Sprache geschrieben ist. Ist das ein bekanntes Ergebnis oder …
5
Codedokumentation: Öffentlich vs. Nicht öffentlich?
Ich bin einer dieser Entwickler, die der Meinung sind, dass der geschriebene Code selbsterklärend sein und wie ein Buch gelesen werden sollte. Bei der Entwicklung von Bibliothekscode für andere Benutzer versuche ich jedoch, so viel Dokumentation wie möglich in die Header-Dateien aufzunehmen. was die Frage aufwirft: Lohnt es sich überhaupt, …
1
Wie kann man einen Algorithmus mit Beispieldaten richtig dokumentieren?
Ich frage mich, was eine Algorithmusdokumentation enthalten sollte. Ich kann keine richtige Richtlinie finden, der ich folgen kann. Ich habe vor, aufzunehmen Zusammenfassung des Algorithmus Beschreibung des Algorithmus Flussdiagramme Pseudocodes Beispiel-Eingabedatensatz (mehrfach) Ausgabedaten Unit-Tests Experimente Der Kunde fordert eine solche Dokumentation an, um: das Vertrauen in unsere eigenen Zahlen zu …
5
Wie kann die mit einem Codeprojekt verknüpfte Dokumentation am besten gespeichert werden?
Wir haben viele Dokumente im Zusammenhang mit unserer Softwareentwicklung. Dazu gehören Anforderungen, Designdokumente, externe PDFs, Kundendateien, Testanweisungen usw. Derzeit sind diese Dokumente über den gesamten Ort verteilt (Wiki, "irgendwo im Netzwerk", eine lokale Entwicklerfestplatte (!)). und noch schlimmere Orte). Was ist der beste Weg, um sie im Auge zu behalten? …
1
Implizite Genauigkeit von Gleitkommafunktionen
Während eines anderen Programmierers Überprüfung Implementierung einer Funktion der Normalverteilung CDF zu berechnen , habe ich einen Vorschlag , um entweder die gesamte Implementierung mit Python eingebauten Funktionen oder verwenden SciPy, eine gemeinsame wissenschaftliche Bibliothek ersetzen. Ein anderer Programmierer wies darauf hin , dass weder math.erfc()noch scipy.stats.norm.cdf()bietet keine Präzision garantiert …
1
So halten Sie Codebeispiele in Javadocs auf dem neuesten Stand
Ich arbeite an einer kleinen Bibliothek, die Implementierungen grundlegender, bekannter String-Metriken bereitstellt. Meistens für meine eigene Ausbildung. Die Entwicklung findet also immer dann statt, wenn ich etwas Freizeit habe. Aus diesem Grund habe ich die meisten Prozesse automatisiert, sodass ich eine Version so oft veröffentlichen kann, wie ich ohne großen …
4
Sollten wir nach Lügencode Ausschau halten?
Dies bezieht sich auf eine Diskussion in einer Antwort und die Kommentare dieser Frage: Was ist mit der Abneigung gegen Dokumentation in der Branche? . In der Antwort wurde behauptet, dass "Code nicht lügen kann" und daher anstelle der Dokumentation der Anlaufpunkt sein sollte. In mehreren Kommentaren wurde darauf hingewiesen, …
3
Wie verfolgen Sie komplexe Geschäftsregeln außerhalb des Codes?
Ich bin daran interessiert zu sehen, wie andere Leute das tun. Insbesondere in Situationen, in denen mehrere verschiedene Clients dieselbe Softwarebasis mit leicht unterschiedlichen Geschäftsregeln verwenden. Welche Art von Praktiken verwenden Sie, um zu dokumentieren, wie alles funktionieren soll, oder um Geschäftsregeln. Wenn ein neuer Entwickler ins Team kommt, ist …
Durch die Nutzung unserer Website bestätigen Sie, dass Sie unsere Cookie-Richtlinie und Datenschutzrichtlinie gelesen und verstanden haben.
Licensed under cc by-sa 3.0 with attribution required.