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.

3
Was ist die Verbindung zwischen literarischer Programmierung und dem Semantic Web?
Ich habe (beiläufig) semantische / ontologiebasierte Ansätze zur technischen Dokumentation untersucht, als ich auf dieses Juwel gestoßen bin : Literate Programming und das Semantic Web sind Ideen aus verschiedenen Zeiten, die einen Zusammenhang haben. Das verlinkte Papier Literate Programming in XML von Norman Walsh behandelt XML-Technologien, die für das Semantic …
3
Wie dokumentiere ich notwendigerweise komplexe Codestrukturen?
Wenn ich einen Code habe, der mathematisch oder strukturell recht komplex und irreduzibel ist, wie würde ich diesen Code dokumentieren? Wie kann ich insbesondere sicherstellen, dass jemand, der möglicherweise nicht über die mathematischen oder architektonischen Fähigkeiten verfügt, die ich habe, dies anhand der Dokumentation verstehen kann? Soll ich auch die …
3
Verwenden eines Wikis für Anforderungen
Ich suche nach Möglichkeiten zur Verbesserung des Anforderungsmanagements. Derzeit haben wir ein Word-Dokument auf einer Website veröffentlicht. Leider können wir (meines Wissens) Änderungen von einer Revision zur nächsten nicht betrachten. Ich würde es sehr bevorzugen, dies zu tun, ähnlich wie mit einem Wiki oder VCS (oder beidem, wie das Wiki …
7
Kommentierungs- / In-Code-Dokumentationsstile
Das mag eine dumme Frage sein, aber sie ist schon eine Weile in meinem Hinterkopf und ich kann nirgendwo anders eine anständige Antwort finden. Ich habe einen Lehrer, der sagt, wir sollten jeden Parameter explizit mit einer Beschreibung auflisten, auch wenn es nur einen gibt. Dies führt zu vielen Wiederholungen: …
3
Dokumentation einer REST-Schnittstelle mit einem Flussdiagramm
Hat jemand Vorschläge zum Erstellen einer Flussdiagrammdarstellung einer REST-artigen Weboberfläche? Um den Mitentwicklern eine gründliche Dokumentation zur Verfügung zu stellen, habe ich mich mit der Modellierung der Schnittstelle zum Ändern und Generieren einer Produktressource beschäftigt: Dieses spezielle System verhält sich bei der Benutzerauthentifizierung / Ressourcenanzahl anders. Bevor ich Änderungen vornehme, …
5
Ich bin damit beauftragt, den Dokumentationsaufwand für ein vorhandenes, vollständig undokumentiertes Softwareprodukt zu leiten. Welche Ressourcen helfen mir dabei?
Ich bin Softwareentwickler bei einem Technologieunternehmen. Ich wurde beauftragt, den Dokumentationsaufwand für das Produkt zu leiten, an dem ich arbeite. Ziel ist es, eine entwicklerinterne Dokumentation zu erstellen, und das Projekt wird auf die Geschäftsseite übertragen, wo es die Anforderungsdokumentation abdeckt. Dieses Projekt ist eine Herausforderung. Insbesondere habe ich es …
2
Verwalten und Dokumentieren von API-Endpunkten vieler Anwendungen in einer Microservice-Architektur
Ich denke, einer der größten Probleme bei der Arbeit mit Microservices besteht darin, sicherzustellen, dass die APIs gut dokumentiert sind und APIs ihr Verhalten nicht ändern, ohne die nachgelagerten Anwendungen zu beeinträchtigen. Dieses Problem wird verstärkt, wenn Sie viele Dienste haben, die voneinander abhängig sind. Vielleicht machen Sie an diesem …
5
Wie kann verhindert werden, dass Änderungen an einer internen API andere Projekte beschädigen?
Wir haben 20 - 30 unabhängige Module / Lösungen. Jedes von diesen hat ungefähr 7 - 10 Projekte mit verschiedenen Klassen, Komponenten usw. Diese werden alle unternehmensintern verwendet. Unser Problem ist, wenn wir eine Änderung in einem Modul vornehmen, müssen wir sicherstellen, dass alle anderen Module aktualisiert werden, die auf …
3
Ist es typisch für große Softwareunternehmen, Code nicht zu dokumentieren oder umzugestalten? [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 6 Jahren . Ich habe bei einem großen Softwareunternehmen angefangen zu …
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.