Was sind technische Spezifikationen? Entsprechen sie den Konstruktionsunterlagen? Wenn nicht, was ist der Unterschied und einige
Ich arbeite als Teil eines Teams an einer vorhandenen Anwendung, für die es keine Inline-Dokumentation und keine technische Dokumentation gibt. Da ich an verschiedenen Fehlerberichten für die Anwendung gearbeitet habe, habe ich eine Art Breadcrumb-Trail für mich geschrieben - Fehlernummern an...
Mein Unternehmen ist bestrebt, das Marktforschungsdatenmanagement zu verbessern. Aktueller Datenverwaltungsstil: "Hey Jimbo, wo ist das Bild von unserem WhatZit 2.0? "Ja, ich erinnere mich an die E-Mail über diese Firma von diesem Typ, gib mir ein paar Minuten Zeit, um meinen Outlook zu...
Wir versuchen, unseren Projektdokumentationsprozess von Google Documents auf eine Reihe von selbst gehosteten Git-Repositorys zu verlagern. Textdokumente sind Git-freundlich genug, da wir normalerweise keine ausgefallene Formatierung benötigen. Wir konvertieren einfach alles in beispielsweise...
Ich bin derzeit Praktikant bei einem staatlichen Auftragnehmer und habe das (widerwärtig unvermeidliche) Gefühl, dass Word der De-facto-Standard im Softwareentwicklungsprozess ist. Das Binärformat macht es sehr schwierig, an Dokumenten so zusammenzuarbeiten, wie ich es von einer Codebasis gewohnt...
Wann haben die Leute angefangen, Readme-Dateien zu schreiben? Es scheint, dass so ziemlich alle Programme diese Datei haben, unabhängig vom Format. Gibt es eine dokumentierte erste Verwendung dieses
Es gibt einige gute Beispiele für gut dokumentierten Code, wie Java API. Aber eine Menge Code in öffentlichen Projekten wie Git und internen Projekten von Unternehmen ist schlecht dokumentiert und nicht sehr einsteigerfreundlich. In all meinen Softwareentwicklungsphasen musste ich mich mit schlecht...
An meinem Arbeitsplatz stehen wir vor der Herausforderung, dass "agil" zu oft "vage Anforderungen, schlechte Akzeptanzkriterien, viel Glück" bedeutet! Wir versuchen, dies als allgemeine Verbesserungsmaßnahme anzugehen. Als Teil davon schlage ich vor, dass wir Designdokumente generieren, die über...
Behaviour-Driven Development mit seiner emblematischen Syntax von „Given-When-Then“ -Szenarien wurde in letzter Zeit wegen seiner möglichen Verwendung als Grenzobjekt für die Bewertung der Softwarefunktionalität hoch geschätzt. Ich stimme definitiv zu, dass Gherkin , oder welches...
Warum wird in einigen Sprachen in der Dokumentation eher "gleich" als "ist" angegeben? Zum Beispiel sagen die Python Docs itertools.chain(*iterables) ... Entspricht : def chain(*iterables): # chain('ABC', 'DEF') --> A B C D E F for it in iterables: for element in it: yield...
Ich arbeite jetzt seit ein paar Jahren an einem Projekt und beginne, eine anständige Nutzerbasis aufzubauen. Ich habe eine Projektseite mit einigen grundlegenden Dokumentationen erstellt, aber es ist derzeit nicht viel mehr als eine FAQ. Ich weiß, dass ich es verbessern muss, damit es sowohl für...
Ich kann nicht zählen, wie oft ich Aussagen im Sinne von "Komponententests sind eine sehr wichtige Quelle für die Dokumentation des getesteten Codes" gelesen habe. Ich leugne nicht, dass sie wahr sind. Persönlich habe ich sie jedoch noch nie als Dokumentation verwendet. Für die typischen...
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 im vergangenen Jahr . Ich...
Es scheint ein wenig umstritten zu sein, alles zu dokumentieren, einschließlich der "JavaBean" -Syntax von Gettern und Setzern für Felder: Die Leute sagen, dass es unnötig lange und sich wiederholende DRY-Unterbrechungen gibt (wiederholen Sie sich nicht) , dass die Namenskonvention alles erklären...
Wir schreiben derzeit funktionale und technische Spezifikationen in einem zweispaltigen Format. Zusammenfassungssatz und technisches Detail. Die Details beziehen sich oft auf einen Anhang mit Diagrammen, Layoutdesigns ect. Ich kämpfe jedoch mit der Zeit, in der ich es schreiben muss: In der...
Hintergrund: Meine Mitarbeiter und ich schreiben einen Artikel für eine akademische Zeitschrift. Im Zuge unserer Recherche haben wir ein Simulationsprogramm in Java geschrieben. Wir möchten das Simulationsprogramm für andere Benutzer frei verfügbar machen. Wir haben uns entschieden, den Code in...
Wir haben also eine Schnittstelle wie diese /// <summary> /// Interface for classes capable of creating foos /// </summary> public interface ICreatesFoo { /// <summary> /// Creates foos /// </summary> void Create(Foo foo); /// <summary> /// Does Bar stuff ///...
Manchmal, wenn auch nicht oft, muss ich mathematische Logik in meinen Code einfügen. Die verwendeten Konzepte sind meist sehr einfach, aber der resultierende Code ist nicht - viele Variablen mit unklarem Zweck und einige Operationen mit nicht so offensichtlicher Absicht. Ich will damit nicht sagen...
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 .
Vor kurzem habe ich daran gearbeitet, Teile der Codebasis, mit denen ich mich derzeit befasse, zu überarbeiten - nicht nur, um sie selbst besser zu verstehen, sondern auch, um es anderen zu erleichtern, die an dem Code arbeiten. Ich neige dazu, mich auf die Seite des Denkens zu lehnen, dass...