Als «documentation» getaggte Fragen

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,...

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...

Ich habe eine MongoDB-Datenbank, deren Schemadesign ich ordnungsgemäß dokumentieren möchte. Ich weiß, dass MongoDB eine NoSQL-Datenbank ist und von Natur aus schemenlos ist, aber ich erzwinge ein Schema durch meine Anwendung und möchte es besser darstellen als einen Ausdruck eines...

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...

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...

Gibt es einen guten Begriff, der ähnlich, aber anders als "veraltet" ist, um zu bedeuten, dass sich eine Methode oder API in der Codebasis befindet, aber nicht verwendet werden sollte, weil ihre Implementierung nicht vollständig ist oder sich wahrscheinlich ändern wird? (Ja, ich weiß, diese...

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...

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...

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...

Geschlossen . Diese Frage muss gezielter gestellt werden . 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 . 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 .

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...

Geschlossen . Diese Frage muss gezielter gestellt werden . 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 . 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...

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...

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,...

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...

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

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...

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 6 Jahren . Ziel ist ein...