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.

6
Können Sie behaupten, dass Ihr Produkt für den Zweck geeignet ist, wenn es OSS-Software verwendet, die dies nicht garantiert?
Ich arbeite an einem Produkt für einen Kunden, der gültig und zweckmäßig sein muss. Es basiert auf einem LAMP-Stack (PHP / Cake), es gibt also GPL-, MIT-, PHP- und APACHE-Lizenzen: "WIE BESEHEN", OHNE GEWÄHRLEISTUNGEN ODER BEDINGUNGEN JEGLICHER ART, die entweder ausdrücklich oder stillschweigend gegeben sind, einschließlich, jedoch nicht beschränkt auf, …
7
Wie kann Scrum an ein akademisches Umfeld angepasst werden?
Derzeit arbeite ich mit einem Professor an meiner Universität zusammen, um neue Lehrpläne für die an meiner Hochschule angebotenen Kurse Software Engineering und Capstone Design zu entwickeln. Bis vor kurzem verwendeten beide Kurse ausschließlich das Wasserfallmodell, weshalb die Schüler einen Großteil ihrer Zeit damit verbrachten, ausführliche Berichte zu verfassen. Auf …
6
Software zur Organisation und Pflege der Projektdokumentation, Spezifikation? [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 auf der Suche nach Software zum Organisieren und Verwalten der projektinternen …
6
Ist das Sprichwort "JSON-Objekt" überflüssig?
Wenn JSON für JavaScript Object Notation steht, sagen Sie dann, wenn Sie JSON object sagen, nicht wirklich "JavaScript Object Notation Object"? Wäre es korrekter, "JSON-Zeichenfolge" zu sagen? Oder wäre es richtiger, einfach JSON zu sagen? (wie in "Diese beiden Dienste übergeben JSON untereinander".)
4
Schreiben einer Softwareanforderungsspezifikation
Ich habe ein paar Fragen zum Schreiben einer Spezifikation und sie sind: Wenn wir eine Software-Spezifikation schreiben, müssen wir unter dem Thema "Definition der Benutzeranforderungen" nur die "Funktionen" und "Einschränkungen" angeben. Fällt "Benutzeroberfläche" unter "Funktionen" oder "Einschränkungen"? Was sind die wichtigsten Schlüsselbereiche (Anforderungen), in die eine Software eingebrochen werden kann …
8
Wie viel Dokumentation ist genug?
Wie viel technische Dokumentation (für zukünftige Entwickler) reicht aus ? Gibt es ein angemessenes Verhältnis zwischen Stundencodierung und Dokumentationsstunden? Papadimoulis meint, dass Sie sollten die geringste Menge an Dokumentation zu erstellen, die benötigt wird, um das bestmögliche Verständnis zu ermöglichen, Ist das eine gute Richtlinie, oder gibt es bestimmte Dinge, …
1
Wie dokumentiere ich eine allgegenwärtige Sprache?
Unser Unternehmen ist dabei, viele manuelle Geschäftsprozesse (und das damit verbundene institutionelle Wissen) in neue Unternehmenssoftware umzuwandeln. Das Projekt läuft sehr gut, aber im weiteren Verlauf ist klar, dass es sowohl auf der Geschäfts- als auch auf der Entwicklungsseite große Verwirrung hinsichtlich der Begriffe und Definitionen gibt. Ich kenne Evans …
5
Ist eine gut geschriebene Dokumentation ein guter Grund, eine Programmiersprache zu lernen? [geschlossen]
Geschlossen . Diese Frage ist meinungsbasiert . 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 . Ich lerne gerade Python, was nicht Teil meines College-Lehrplans …
4
Schreiben von Akzeptanztestfällen
Wir integrieren einen Testprozess in unseren SCRUM-Prozess. Meine neue Aufgabe ist es, Akzeptanztests für unsere Webanwendungen zu schreiben, um sie später zu automatisieren. Ich habe viel darüber gelesen, wie Testfälle geschrieben werden sollten, aber keiner hat mir praktische Ratschläge zum Schreiben von Testfällen für komplexe Webanwendungen gegeben, und stattdessen wurden …
5
Erstellen eines Kodierungsstandards-Dokuments
Ich arbeite in einer Firma für Steuerungssysteme, deren Hauptaufgaben SCADA und PLC sind , zusammen mit anderen Steuerungssystemen. Software-Entwicklung ist nicht wirklich etwas, was das Unternehmen tut, abgesehen von Kleinigkeiten hier und da, bis die Entscheidung getroffen wurde, ein internes Projektmanagement- und Bewertungssystem einzurichten. Dieses Projekt wurde von Leuten übernommen, …
8
Wo soll die Code-Dokumentation abgelegt werden?
Ich benutze derzeit zwei Systeme, um Code-Dokumentation zu schreiben (benutze C ++): Dokumentation zu Methoden und Klassenmitgliedern wird unter Verwendung des Doxygen-Formats neben dem Code hinzugefügt. Auf einem Server wird Doxygen auf den Quellen ausgeführt, sodass die Ausgabe in einem Webbrowser angezeigt werden kann Übersichtsseiten (die eine Reihe von Klassen, …
8
In Zukunft von einem Einzelprojekt zu einem Teamprojekt wechseln. Was soll ich jetzt in Vorbereitung machen und was kann warten?
Um das zu erläutern, bin ich daran interessiert zu wissen, was die Leute denken, dass Sie in einem Ein-Mann-Projekt implementieren müssen (Team-Quellcodeverwaltung, Dokumentation, Builds usw.) und welche Dinge erst zu dem Zeitpunkt erledigt werden müssen, zu dem die zweite Person kommt auf das Projekt. Jeder, der Erfahrung mit diesem Szenario …
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.