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.

4
Gibt es Bemühungen, eine gemeinsam bearbeitete HTML / JS / DOM-Referenz zu erstellen?
W3Schools hat den Ruf, unvollständig, manchmal falsch und voller Werbung zu sein. Wenn Sie beim Beantworten einer SO-Frage nach einigen Dingen suchen oder auf eine Dokumentation verweisen möchten, ist dies immer noch die einzige nützliche browserübergreifende Ressource. Es gibt andere Ressourcen wie das Mozilla Developer Network , das JavaScript immer …
6
So dokumentieren Sie Geschäftsregeln
Ich frage mich, was die formale und am häufigsten praktizierte Methode zur Dokumentation von Geschäftsregeln wäre. Wie dokumentieren Sie auch die UI-Spezifikationen von Entwicklungsartefakten (z. B. Dokumentieren von Formularfeldern und Verhalten von Schaltflächen in Formularen, Infotext usw.)?
6
Kann die Erstellung eines Software-Design-Dokuments nach der Entwicklung gerechtfertigt sein?
Derzeit arbeite ich an meinem Abschluss für mein "Software Development" -Studium, in dem ich komplexe Software individuell in einem externen Unternehmen entwickeln muss. Dies alles muss strukturiert erfolgen und alle entsprechenden Dokumente erstellen. Für dieses Projekt habe ich mich entschieden, mit den IEEE-Standarddokumenten zu arbeiten: Software Requirements Document (SRS), Software …
1
Gibt es empirische Studien zu den Auswirkungen des Kommentierens von Quellcode auf Softwarequalität, Wartbarkeit und Entwicklerproduktivität? [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 6 Jahren . Ich bin ein Verfechter des Kommentierens des Quellcodes und des Dokumentierens von Softwareprodukten. …
2
Dokumentieren einer Programmiersprache: Referenzhandbuch
Wir prüfen die Überarbeitung der Dokumentation für unsere gesamte Produktlinie. Ein Teil davon enthält Referenzhandbücher für eine Programmiersprache, die als Teil des Systems verwendet wird. Wie kann ein Referenzhandbuch für eine Programmiersprache am besten strukturiert werden, um eine maximale Benutzerfreundlichkeit für diejenigen zu gewährleisten, die neu in der Sprache sind? …
4
Wie kann man rechenintensiven Code dokumentieren und lehren, der bis zur Unkenntlichkeit optimiert ist?
Gelegentlich gibt es 1% des Codes, der rechenintensiv genug ist und die schwerste Art der Optimierung auf niedriger Ebene erfordert. Beispiele sind Videoverarbeitung, Bildverarbeitung und alle Arten der Signalverarbeitung im Allgemeinen. Ziel ist es, die Optimierungstechniken zu dokumentieren und zu vermitteln, damit der Code nicht unbrauchbar wird und von neueren …
5
Welche Ergebnisse kann der Kunde für eine Webanwendung erhalten? [geschlossen]
Geschlossen . Diese Frage muss fokussierter sein . Derzeit werden keine Antworten akzeptiert. Möchten Sie diese Frage verbessern? Aktualisieren Sie die Frage so, dass sie sich nur auf ein Problem konzentriert, indem Sie diesen Beitrag bearbeiten . Geschlossen vor 4 Jahren . Ich habe eine Webanwendung fertiggestellt, die im Wesentlichen …
4
Wie können Open Source-Projekte ohne Dokumentation zu Design oder Architektur erfolgreich sein?
Ich möchte meine Programmierkenntnisse verbessern, indem ich berühmte Open-Source-Projekte studiere, aber ich finde es leicht, mich zu verlaufen, wenn ich einfach in ihren Quellcode springe. Daher habe ich mich entschlossen, die Dokumentation zu Design oder Architektur (z. B. UML-Diagramme) zu lesen, um zunächst eine allgemeine Vorstellung von der Organisation des …
3
Verfassen hochwertiger Softwarevorschläge [geschlossen]
Geschlossen . Diese Frage muss fokussierter sein . Derzeit werden keine Antworten akzeptiert. Möchten Sie diese Frage verbessern? Aktualisieren Sie die Frage so, dass sie sich nur auf ein Problem konzentriert, indem Sie diesen Beitrag bearbeiten . Geschlossen vor 5 Jahren . Ich habe kürzlich einige Vorschläge für Softwareprojekte gelesen …
9
Codedokumentation zuerst? [geschlossen]
Geschlossen . Diese Frage basiert auf Meinungen . Derzeit werden keine Antworten akzeptiert. Möchten Sie diese Frage verbessern? Aktualisieren Sie die Frage, damit sie durch Bearbeiten dieses Beitrags mit Fakten und Zitaten beantwortet werden kann . Geschlossen vor 2 Jahren . Hat jemand jemals versucht, zuerst eine vollständige Codedokumentation zu …
9
Studien zu Produktivitätsgewinnen / -verlusten bei der Codedokumentation
Nach langem Suchen habe ich eine grundlegende Frage zu einer in der Welt der Softwareentwicklung bekannten Annahme nicht beantwortet: WAS BEKANNT IST: Die Durchsetzung einer strengen Richtlinie für eine angemessene Codedokumentation (sei es Doxygen-Tags, Javadoc oder einfach eine Fülle von Kommentaren) erhöht den Zeitaufwand für die Entwicklung von Code. ABER: …
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.