Texte und Programm Codes leicht durchsuchen

Hallo zusammen,

ich bin dabei unsere Prozesse effizienter zu gestallten. Wir haben viele gute Lösungen in Form von Programm-Codes bei den einzelnen Mitarbeitern in ihrem „Werkzeugkoffern“. Jetzt würden wir gern die Lösungen in am besten eine Datenbank reinschmeißen und es für alle verfügbar machen.

Was würdet ihr mir empfehlen? Evtl. auch eine fertige Lösung.
Die Lösungen sind Programm Codes, die leider noch nicht im git repo sind.
Worauf soll ich achten, damit es leicht durchsuchbar ist?

Ich würde mich sehr über Erfahrungswerte freuen.

Viele Grüße
Ania

Erstmal solltest du darüber nachdenken, wie man denn Codeschnipsel weiter verwenden soll, der in nicht ausreichend und standardisiert kommentiert und erläutert ist.

Dann fallen schon mal 99% der Schipsel weg und es wird sehr übersichtlich.

Und als nächstes überleg dir Kategorien darüber, für was die Dinger sind. Darunter sortierst du die übrig gebliebenen Schnipsel mit einer sinnvollen Überschrift (die die verwendete Programmiersprache enthält) und einer KURZEN Beschreibung ein. Dann bist du auch schon fertig, mehr kann man kaum tun.

Datenbank ist viel zu weit oben angesiedelt, eine Liste mit Inhaltsverzeichnis reicht völlig.

2 Like

Hallo!

Ergänzend:

Es klingt, als ob du eine Wissensdatenbank aufbauen willst. Das muß nicht zwingend eine Datenbank im wörtlichen Sinn sein, sondern kann auch ne Wiki-Seite oder sowas in der Art sein.
Sowas ist grundsätzlich ne gute Idee, bei Code muß man aber aufpassen.

Grundsätzlich kann man da Code-Beispiele unterbringen, die vielleicht zu komplex und umfangreich sind, um sie direkt im Code zu dokumentieren.
Aber die Algorithmen, also der Inhalt der Funktionen selbst gehören da nicht rein. Denn:
Im schlimmsten Fall wird jeder, der das gleiche Problem hat, den Code von der Wissensdatenbank kopieren und in den eigenen Code einbauen. Möglicherweise werden manche sich den Code auch in eigene Bibliotheken packen.
Am Ende wurde dieser Algorithmus an verschiedenen Stellen der Projekte immer wieder neu rein kopiert. Wenn dann etwas am Algorithmus geändert werden muß, dann seid ihr gekniffen.

Zum Thema git:
Das verstehe ich nicht. Du klingst, als ob ihr git schon nutzt.
Wie kann man denn Code in git haben, wenn die „Werkzeugkisten“ der Programmierer nicht auch mit da drin sind?
Als Softwareentwickler möchte ich auch für private Zwecke nicht auf eine Versionsverwaltung verzichten, da muß das in ner Firma doch auch möglich sein?

Im Grunde kann man jedem Entwickler im git doch nen Bereich als Spielwiese zuordnen, wo er alles mögliche bunkern kann. Aber alles, was dann tatsächlich genutzt werden soll, gehört in offizielle Bibliotheken.
Das wiederum erfordert nun etwas Arbeit, denn es muß ja eine Bestandsaufnahme gemacht werden, und geschaut werden, was wie wo landen soll.

1 Like

Ich versuche mal zu beschreiben, ob ich euch richtig verstanden habe.

  1. Kategorien bilden

Z.B.

  1. Materialwirtschaft
    -> Titel des Problems/Anforderung A
    –> Beschreibung des Problems A
    —> Lösungsansatz sowohl organisatorischer als auch technischer Natur des Problems A inklusive Link zum für alle zugänglichen aus der Firma git Repo
  2. Controlling
    -> Titel des Problems/Anforderung B
    –> Beschreibung des Problems B
    —> Lösungsansatz sowohl organisatorischer als auch technischer Natur des Problems B inklusive Link zum für alle zugänglichen aus der Firma git Repo

Vorraussetzung ist, der Code ist standadisiert und kommentiert und somit für alle lesbar.

Empfehlung ist auf Wiki zu gehen.

Blockquote Im schlimmsten Fall wird jeder, der das gleiche Problem hat, den Code von der Wissensdatenbank kopieren und in den eigenen Code einbauen.

Vielleicht sollten wir dem Szenario mit automatischen Tests entgegenwirken um rechzeitig festzustellen, wo es knallt?

Wir haben git, aber nicht jeder nutzt es, und es ist richtig wir müssen eine Bestandaufnahme machen. Was gibt es, was ist wiederverwendbar was nicht. Ich denke, hier ist noch Schulung und Überzeugungsarbeit zu leisten.

Blockquote Im Grunde kann man jedem Entwickler im git doch nen Bereich als Spielwiese zuordnen, wo er alles mögliche bunkern kann. Aber alles, was dann tatsächlich genutzt werden soll, gehört in offizielle Bibliotheken.
Das wiederum erfordert nun etwas Arbeit, denn es muß ja eine Bestandsaufnahme gemacht werden, und geschaut werden, was wie wo landen soll.

Da hast Du wohl Recht. Wenn wir uns verbessern wollen müssen wir so agieren.

Falsch. Es gibt Code für bestimmte Funktionen, nicht für bestimmte Themen. Werktage im Kalender ausrechnen funktioniert in Controlling und Materialwirtschaft genau gleich.

Der Code soll nicht standardisiert sein, sondern die Beschreibung. Da sollen bestimmte Voraussetzungen genannt sein, die benutzten Variablen (was ist, wenn die sich anderswo im Programm ändern, weil doppelt verwendet?), welche Werte in welcher Form rein- und welche rausgehen. Welche zusätzlichen Informationen von wo kommen müssen (was ist, wenn die Datenbank umgestellt wird?). Welche Konstanten Werte verwendet werden (stell dir vor, die Umsatzsteuer würde geändert, ist aber als Faktor 0,19 irgendwo versteckt).
Datum ist natürlich wichtig - irgendwann ist das Zeug einfach nur alt und überholt und passt nicht mehr zu den aktuellen Algorithmen/Arbeitsweisen.
Name des Erstellers wäre auch ganz interessant - oder wen soll man im Zweifel fragen?

Wer hat dafür Zeit? Vielleicht solltest du erst mal feststellen, ob sich der Aufwand überhaupt lohnt.