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.

14
Was ist mit der Abneigung gegen Dokumentation in der Branche?
Es scheint eine Abneigung gegen das Schreiben der grundlegendsten Dokumentation zu geben. Unsere Projekt-READMEs sind relativ einfach. Es gibt nicht einmal aktualisierte Listen von Abhängigkeiten in den Dokumenten. Gibt es etwas, das ich in der Branche nicht kenne, das Programmierer dazu bringt, keine Dokumentation zu schreiben? Ich kann bei Bedarf …
6
"Ich", "Wir" oder Weder in der Codedokumentation
Ich finde mich (hoffentlich) hilfreiche Kommentare in Code (C ++) Dokumentation des Typs schreiben: The reason we are doing this is... Der Grund, warum ich "wir" anstelle von "ich" benutze, ist, dass ich viel akademisch schreibe, wobei "wir" oft bevorzugt werden. Also hier ist die Frage. Gibt es einen guten …
12
Bei der Dokumentation in OOP sollte vermieden werden, dass angegeben wird, ob ein "Getter" Berechnungen durchführt oder nicht.
Das CS-Programm meiner Schule vermeidet jede Erwähnung von objektorientierter Programmierung, deshalb habe ich einige Lektüre allein gemacht, um es zu ergänzen - insbesondere die objektorientierte Softwarekonstruktion von Bertrand Meyer. Meyer weist wiederholt darauf hin, dass Klassen möglichst viele Informationen über ihre Implementierung verbergen sollten, was sinnvoll ist. Insbesondere argumentiert er …
6
Git-freundliches Tabellenformat? [geschlossen]
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 Multimarkdown mit der Option, LaTeX für komplexe Fälle einzubetten. Aber Tabellenkalkulationen sind eine ganz andere Geschichte ... …
9
Können Nicht-IT-Mitarbeiter mit einem Wiki umgehen? [geschlossen]
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 durchsuchen" "Wer hat die neueste Ausgabe des …
6
Methodik zur Dokumentation der vorhandenen Codebasis
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 verschiedenen Stellen, damit der nächste Entwickler anhand dieser Fehlernummer …
3
Welche Hindernisse stehen dem Entwicklungsprozess bei der Verwendung von Markup-Sprachen im Klartext gegenüber, im Gegensatz zu z. B. Microsoft Word? [geschlossen]
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 bin. Die Verwendung von Nur-Text-Markups (mit Sprachen wie LaTeX, Markdown, ReStructured Text …
3
Herkunft von "Readme"
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 Dokuments?
2
Wie mache ich eine Dokumentation für Code und warum ist Software (oft) schlecht dokumentiert?
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 dokumentiertem Code auseinandersetzen. Ich habe die folgenden Dinge …
5
Designdokumente als Teil von Agile
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 die User Story-Ebene hinaus das Ergebnis vorläufiger Untersuchungen der Auswirkung eines bestimmten …
4
Ist BDD tatsächlich für Nicht-Programmierer beschreibbar?
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 Feature-Definitionsskript Sie bevorzugen, ein geschäftlich lesbares DSL ist und bereits einen Wert als solches bietet. …
7
Zuerst freigeben oder zuerst dokumentieren?
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 neue als auch für …
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.