Dokumentieren von Lösungen, die in einem Softwareprojekt implementiert wurden

Als Softwareentwickler bleibe ich beim Implementieren eines Features hängen und löse es dann irgendwie durch viel Suchen, Lesen von Artikeln, Tutorials usw.

Aber ich würde eine Web-App (z. B. ein zentrales Repository) bevorzugen, in der ein Workflow definiert ist, der es mir ermöglicht, diese Art von Lösungen für bestimmte Probleme in einem Softwareprojekt zu speichern/dokumentieren . Damit ich das Repo in Zukunft erneut durchsuchen und darauf verweisen kann, um mich daran zu erinnern, wie ich ein Problem gelöst habe, wenn ich erneut darauf stoße.

Bloggen hilft, aber einige Programmierprobleme sind sehr klein und werden für einen Blogbeitrag sehr trivial. Auf der anderen Seite kann ich keine vollständige technische Lösung für Issue Tracker beschreiben.

Bitte schlagen Sie vor, ob es eine solche Web-App gibt.

Antworten (2)

Ich verwende ein Wiki für einen ähnlichen Anwendungsfall.

Das Gute: Sie können die Seitenarchitektur/-organisation/-navigation selbst bauen.
Das Schlimme: Sie müssen die Site-Architektur/Organisation/Navigation selbst erstellen.

Fast jedes Wiki sollte für Ihren Fall geeignet sein, aber es lohnt sich, sich die Details anzusehen, die Ihnen wichtig sind.

Wikipedia hat eine Liste und einen Vergleich von Wiki-Software. Die Seite wikimatrix.org ermöglicht den Vergleich von Wikis basierend auf ausgewählten Features/Anforderungen.

Unterschätzen Sie nicht das Aussehen und die Haptik. Damit ein solches Wiki wirklich Sinn macht, sollten Sie es oft besuchen und bearbeiten. Aber wenn Ihnen das Bearbeiten keinen Spaß macht (dh nicht einfach/schnell, hässlich, schlechte Bedienbarkeit), können Sie es verschieben oder nach den ersten Tagen der Begeisterung aufhören.

Persönlich verwende ich WikkaWiki ( seit mehreren Jahren täglich stündlich, habe etwa 2000 Seiten mit mehr als 35000 Bearbeitungen erstellt):

  • ZAHNSEIDE.
  • PHP, MySQL.
  • Schnell, kleiner Cruft.
  • Enthält Syntax für Codeblöcke ( %% your code here %%) und unterstützt Syntaxhervorhebung ( %%(php) your PHP code here %%). Sie können sogar einen Dateinamen (der auch das Herunterladen der Codedatei ermöglicht) und Startzeilennummern ( %%(php;15;test.php) your "test.php" here, starting from line 15 %%) angeben.
  • Sein Standard-Editor unterstützt Tab(wenn Sie Code auf diese Weise einrücken möchten).
  • Da die URLs „schön“ sind, können Sie die URLs der Seiten, die Sie besuchen/bearbeiten möchten, direkt eingeben (was dank der automatischen Vervollständigung des Browsers viel Zeit spart):
    http://example.com/PHP
    http://example.com/PHP/edit

Mögliche Nachteile: ziemlich langsamer Entwicklungsprozess (was gut für mich ist, solange das Projekt nicht tot ist); keine volle Unicode-Unterstützung (die nächste Version, 1.4, wird auf volles UTF-8 umstellen; aber fast alles sollte schon jetzt gut funktionieren).

DokuWiki ist ein weiteres nettes Wiki. Es ist auch FLOSS, verwendet PHP, benötigt aber keine Datenbank (speichert alle Wiki-Seiten in Textdateien).

Ich habe mich schließlich entschieden, mich mit Git und Markdown zufrieden zu geben . Für Git-Hosting habe ich mich für GitLab entschieden , weil es im Grunde genommen GitHub mit zusätzlichen kostenlosen privaten Repos ist . Die Idee ist, ein einziges Repo für alle Protokolle und dann ein einziges Verzeichnis für jedes Protokoll oder jeden Eintrag zu haben:

-root
  -Entry1
     Entry1.md
     file1.js
  -Entry2
     Entry2.md
     Entry2.html

Ich plane auch, relative Verknüpfungen und Zeilenbereichshervorhebungen zu nutzen, um Codedateien innerhalb eines Eintragsverzeichnisses oder über das gesamte Repo zu referenzieren.

Vielleicht kann ich eines Tages sogar ein Repo für meinen Blog erstellen.