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.

1
Was ist das allgemeine Format einer Software-Design-Spezifikation?
Ich versuche, eine Software zu dokumentieren, die ich ausführlich geschrieben habe. Eine SAS ist zu hoch und deckt die API nicht ab. Ich habe einige Beispiele für ein Sicherheitsdatenblatt online gefunden, sehe aber keinen Trend in ihrem Format. Ich frage mich, ob es einige allgemeine Richtlinien zum Schreiben einer Software-Design-Spezifikation …

3
Implementierung einer Reihe spezifischer Werte im Vergleich zur Verwendung einer Art generischer Menge mit erweiterten Überprüfungen
Ich arbeite derzeit an einer Set-Implementierung in JavaScript. Dies sollte Generika simulieren, wie sie aus Java oder C # bekannt sind. Ich benötige eine veränderbare Version davon (ermöglicht das Hinzufügen / Entfernen von festgelegten Werten) und eine unveränderliche. Meine Konstruktorsignatur sieht folgendermaßen aus: new GenericSet( 'number', [ 10, 20, 30 …


2
Wie dokumentiere ich Anforderungen für eine API systematisch?
Ich arbeite derzeit an einem Projekt, in dem ich die Anforderungen von zwei bestimmten IT-Systemen, die Cloud Computing verwenden, für eine Cloud-API analysieren muss. Mit anderen Worten, ich muss analysieren, welche Anforderungen diese Systeme an eine Cloud-API haben, damit sie diese wechseln und gleichzeitig ihre aktuellen Ziele erreichen können. Lassen …

4
Was ist ein „Umsetzungsplan“? [geschlossen]
Geschlossen. Diese Frage ist nicht zum Thema . Derzeit werden keine Antworten akzeptiert. Möchten Sie diese Frage verbessern? Aktualisieren Sie die Frage so dass es beim Thema für Software Engineering Stapel Börse. Geschlossen vor 4 Jahren . Vor kurzem wurde mir die Aufgabe übertragen, ein Implementierungsplandokument zu erstellen. Als ich …

6
Wie verwende ich Unit-Tests als Informationsquelle?
Ein Kollege von mir war einmal auf einem Seminar über agile Entwicklung, wo er hörte, dass es möglich ist, Unit-Tests als technische Dokumentation zu verwenden. So etwas wie die Verwendung von Komponententests als Beispiel für die Verwendung der Klasse. Eine schnelle Google-Suche lieferte TDD und Dokumentation , was beweist, dass …


6
Was ist ein gutes nichttechnisches Beispiel für einen kumulativen Fehler?
Ich arbeite an einem Bericht, in dem die Auswirkungen eines kumulativen Fehlers in nichttechnischen Begriffen erläutert werden müssen und warum es wichtig ist, absolute Berechnungen zu verwenden. Definition von 'kumulativem Fehler' von dictionary.com : ein Fehler, dessen Grad oder Signifikanz während einer Reihe von Messungen oder Berechnungen allmählich zunimmt; Ein …

3
Gibt es eine Django-Referenz?
Ich bin neu in Django. Ich habe festgestellt, dass die offiziellen Themenhandbücher https://docs.djangoproject.com/de/1.3/ ein ausgezeichneter Ort zum Lernen sind. Aber jetzt bin ich an einem Ort, an dem ich eine Kurzreferenz benötige, um zu sehen, welche Methoden ein Objekt hat, welche Argumente es benötigt, was es zurückgibt usw., ähnlich wie …


2
Können Sie eine gute Testplanvorlage empfehlen?
Können Sie einem agilen Testteam eine gute Testplanvorlage empfehlen? Ich weiß, dass es Vorlagen zum Testen im Web gibt und habe mir bereits einige von Suchmaschinen gefundene Vorlagen angesehen, aber ich könnte wirklich etwas Leichtes verwenden, das bereits von erfahrenen Testern ausprobiert wurde und bekanntermaßen gut funktioniert. Viele Vorlagen, die …

6
Wie nützlich sind Funktionspunkte? [geschlossen]
Geschlossen . Diese Frage basiert auf Meinungen . Derzeit werden keine Antworten akzeptiert. Möchten Sie diese Frage verbessern? Aktualisieren Sie die Frage, damit sie mit Fakten und Zitaten beantwortet werden kann, indem Sie diesen Beitrag bearbeiten . Geschlossen vor 4 Jahren . Wie nützlich ist es, Funktionspunkte zu messen ? …

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.