Question
https://rdmorganiser.github.io/terms/questions/smp/quality-assurance/documentation/who-is-responsible
  • attribute
    https://rdmorganiser.github.io/terms/domain/smp/documentation/who-is-responsible
  • is_collection
    False
  • is_optional
    False
  • help_en
    It is advisable to think about an adequate strategy for the documentation of the project, which also should be consistent with the framework conditions of the project. Documentation is only helpful if it corresponds to the current status of the software. Often, this is not given high priority compared to writing the code. It is, however, advisable to describe the developed software sensibly and completely. Documentation should also include statements about the software architecture, the development environment, the code style guide and installation procedures. The following questions could be answered in a documentation: * What should be documented, e.g. process, code or system? * For what purpose should documentation be done? * At what level of detail should be documented? * Who is the target group for which type of documentation, e.g. user documentation, programmers documentation, API documentation? * In which formats will the documentation be produced, e.g. README file, docstring, release notes, changelog?
  • text_en
    How is software documentation created?
  • help_de
    Es ist empfehlenswert, sich adäquate Strategie für die Dokumentation des Projekts zu überlegen, die auch den Rahmenbedingungen des Projekts entspricht. Eine Dokumentation ist nur hilfreich, wenn sie dem aktuellen Stand der Software entspricht. Häufiger wird dem gegenüber dem Schreiben am Code keine hohe Priorität eingeräumt. Es ist jedoch ratsam, die entwickelte Software sinnvoll und vollständig zu beschreiben. Eine Dokumentation sollte auch Aussagen über die Software-Architektur, die Entwicklungsumgebung,den Code Style Guide und Installationsvorgaben treffen. Folgende Fragen könnten in einer Dokumentation beantwortet werden: * Was soll dokumentiert werden, z.B. Prozess, Code oder System? * Zu welchem Zweck soll dokumentiert werden? * In welchem Detailgrad soll dokumentiert werden? * Wer ist die Zielgruppe für welche Art von Dokumentation, z. B. Benutzerdokumentation, Programmiererdokumentation, API-Dokumentation? * In welchen Formaten soll die Dokumentation erstellt werden, z. B. README-Datei, Docstring, Release Notes, Changelog?
  • text_de
    Wie wird eine Software-Dokumentation erstellt?
  • widget_type
    textarea
  • value_type
    text
  • conditions