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.

7
Sollte ein Designdokument eine Diskussion der Vor- und Nachteile eines bestimmten Designs enthalten oder sollte es sich auf Fakten und Gründe konzentrieren?
Ich bin gerade dabei, ein Designdokument zu aktualisieren, damit es für zukünftige Entwickler korrekt und aktuell ist. Derzeit konzentriert sich das Dokument nur auf die Fakten und zeigt, wie das Design ist. Es gibt keine Begründung für die vorgelegten Entscheidungen. Ich glaube, es ist wichtig, die Gründe zu erfassen, damit …
7
Was soll ich in den Header der Klassendokumentation aufnehmen?
Ich suche nach einem informativen Klassendokumentationsformat für meine Entity-, Business Logic- und Data Access-Klassen. Ich fand folgende zwei Formate von hier Format 1 ///----------------------------------------------------------------- /// Namespace: <Class Namespace> /// Class: <Class Name> /// Description: <Description> /// Author: <Author> Date: <DateTime> /// Notes: <Notes> /// Revision History: /// Name: Date: Description: …
5
Wie dokumentiere ich ein bereits entwickeltes Projekt?
Ich würde gerne wissen, welche Optionen zur Dokumentation eines bereits entwickelten Projekts zur Verfügung stehen, da die Entwickler, die daran gearbeitet haben, nicht einmal eine einzige Dokumentationsseite geschrieben haben. Das Projekt enthält keine anderen Details als viele Seiten mit Skripten mit Funktionen, die von Entwicklern geschrieben und geändert wurden, die …
3
Wie liest man RFCs und ähnliche Dokumente? [geschlossen]
Geschlossen . Diese Frage erfordert Details oder Klarheit . Derzeit werden keine Antworten akzeptiert. Möchten Sie diese Frage verbessern? Fügen Sie Details hinzu und klären Sie das Problem, indem Sie diesen Beitrag bearbeiten . Geschlossen vor 4 Jahren . RFC : Request for Comments (RFC) ist ein von der Internet …
5
Software-Manager, der Entwickler zum Projektmanagement veranlasst
Ich bin ein Softwareentwickler, der in einem Embedded-System-Unternehmen arbeitet. Wir haben einen Projektmanager, der sich um den gesamten Projektzeitplan kümmert (einschließlich Elektrik, Qualität, Software und Fertigung), daher ist sein Softwarezeitplan sehr kurz. Wir haben auch einen Software Manager, der mein Chef ist. Er veranlasst mich, den Software-Zeitplan zu schreiben und …
7
Dokumentation erniedrigend - wie geht man damit um?
Wichtig : Wir haben keinerlei Probleme mit der Quelltextdokumentation . Dies gehört zum regulären Code-Audit und wird auf dem neuesten Stand gehalten. Unser Problem liegt in der Entwicklerdokumentation (oder, wenn Sie möchten, "extern"), in kleinen blogähnlichen Tipps von Programmierern zu Programmierern, die in der Regel einmal geschrieben wurden und häufig …
4
Was genau beinhaltet 'Dokumentation'?
Wenn wir "Dokumentation" für ein Softwareprodukt sagen, was beinhaltet das und was sollte das nicht beinhalten? Beispiel: Eine kürzlich gestellte Frage, ob Kommentare als Dokumentation betrachtet werden. Es gibt aber auch viele andere Bereiche, für die dies eine berechtigte Frage ist, von denen einige offensichtlicher sind als andere: Handbücher (offensichtlich) …
5
Was ist eine Problemdomäne?
Ich muss mein Programm für ein Schulprojekt dokumentieren und wir haben einen Abschnitt namens "Problemdomäne", aber ich habe keine Ahnung, was ich in diesem Abschnitt besprechen soll. Die Frage ist also: Was soll in der Problemdomäne diskutiert werden?
5
Alternativ zur HTML-Hilfe
Derzeit verwenden wir ein System namens AsciiDoc , mit dem wir Dokumentation in einem einfachen Text-Markup erstellen können. Daraus können wir mehrere Ausgabeformate generieren. Wir verwenden nur die Ausgabeformate pdf und chm. Ich habe mich gefragt, ob es eine Alternative zu chm gibt. Was ich suche, ist etwas, das mit …
5
Warum sollte man zwischen funktionalen und nicht funktionalen Anforderungen unterscheiden?
Ich verstehe den Unterschied zwischen beiden, werde aber von meinen Kollegen gefragt, ob Kennzeichnungsanforderungen als funktional oder nicht funktional (oder vorübergehend) gelten. Warum sich die Mühe machen? Er verbrachte zwei Tage damit, eine Anforderungsliste für ein Projekt durchzuarbeiten, und sah keinen Nutzen darin, da das Endergebnis darin bestand, das Dokument …
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.