So bauen Sie vor Ihrem nächsten Job eine Entwickler-Wissensdatenbank auf

Haftungsausschluss: Dies ist keine Anzeige für Obsidian.

Das Onboarding in ein neues Unternehmen ist harte Arbeit. Alle Informationen gerade zu halten ist ein eigener Arbeitsablauf, der Nachdenken und Aufmerksamkeit verdient. Unzählige Namen, Gesichter*, Teams, Initiativen und Akronyme fliegen vor Mittag vorbei. Glaub mir. Ich bin gerade dabei. Diese Woche bin ich auf einem System gelandet, mit dem ich ziemlich zufrieden bin.

Sie sind ein Wissensarbeiter. Erstellen Sie eine Wissensdatenbank

Sie benötigen einen Ort, an dem Sie alle Informationen ablegen können, die Sie erhalten. Dies sind einige der Dinge, über die ich spreche:

  • Personen
  • Mannschaften
  • Repositorys
  • Beziehungen zwischen Teams, Repositorys, Personen usw.
  • Initiativen
  • Ihr Arbeitsprodukt und Ihre Aufgaben
  • „Playbooks“ für allgemeine Aufgaben
  • Tägliche Tagesordnungen
  • Notizen der Besprechung
  • Ideen
  • Fragen, die du jemandem stellen musst

ich empfehle Obsidian. Es ist im Wesentlichen ein Markdown-Editor – aber es ist so viel mehr als das. Es ist Open Source. Es funktioniert von Ihrem lokalen Dateisystem aus – keine Cloud-basierten Datenschutzbedenken. Es ermutigt Sie, ein dichtes Wissensnetzwerk mit vielen Links und Tags aufzubauen. Es hat auch eine reiche Auswahl an offiziell und Community-Plugins.

Pflanzensamen

Es kann ziemlich einschüchternd sein, mit einem leeren Verzeichnis zu beginnen. Sie müssen Ihre Wissensdatenbank jedoch nicht manuell erstellen. Versuchen Sie das Seeding aus verfügbaren Datenquellen.

Ingenieur-Wiki

Verfügt Ihre Organisation über ein Engineering-Wiki auf GitHub? Klonen Sie es und legen Sie es direkt in Ihren Obsidian-Ordner. Jetzt haben Sie Tonnen von Seiten anstelle einer leeren Tafel.

Sie sind der wichtigste Exporteur Ihres Unternehmens beim Onboarding. Niemand sonst erinnert sich daran, wie es war, an Bord zu gehen, und – vor allem, wenn sie vor langer Zeit an Bord gegangen sind – könnte die Erfahrung jetzt ganz anders sein. Sie können Ihren Blickwinkel nutzen, um das Onboarding-Erlebnis des nächsten Mitarbeiters zu verbessern. Tragen Sie beim Onboarding zum Wiki bei. Machen Sie es weniger verwirrend.

Ich empfehle, einen Zweig des Repositorys auszuchecken, damit alle Änderungen, die Sie vornehmen, PR-fähig sind. Eine wirklich einfache Änderung, die eine Menge Mehrwert schafft, ist das Hinzufügen von Hyperlinks. Es gibt oft eine obskure Seite, die etwas beschreibt, zu dem keine Links führen. Hyperlinks sind ein besseres Erkennungstool als grep, also fügen Sie sie hinzu.

Github-Repositorys

Fügen Sie in Ihrer Wissensdatenbank für jedes Repository in Ihrer Organisation eine Markdown-Datei hinzu. Wenn Sie GitHub verwenden, laden Sie die GitHub-CLI herunter. Von dort aus können Sie eine JSON-Datei der obersten ‘n’ generieren repos in Ihrer Organisation… wenn Sie können, holen Sie sich vielleicht alle. Sie sind nach dem letzten Commit sortiert.

$ gh repo list [yourorgname] --limit 1000 --json name,description,createdAt,updatedAt`) > your-repos.json

Ich habe ein kleines Node-Skript geschrieben, um auch Markdown-Dateien zu generieren.

const { writeFileSync } = require('fs');
const repos = require('./your-repos.json');

const pathToObsidian = '...';

function renderMarkdown(repo) {
	return `# [${repo.name}](https://github.com/yourorg/${repo.name})
	
  >> whatever you want here, description is nice...<<`;
}

for (const repo of repos) {
	writeFileSync(
	  `${pathToObsidian}/repos/${repo.name}.md`, 
	  renderMarkdown(repo)
  );
}

Menschen und Teams

Dieser ist schwieriger zu generisch zu machen. Bei meinem neuen Job fand ich eine ziemlich gute Liste der Engineering-Organisation in Google Groups, kopierte die HTML-Tabelle aus dem Browser in Google Sheets und exportierte dann eine CSV-Datei. Ihre Quelle der Wahrheit könnte Slack, GitHub Teams oder etwas ganz anderes sein. Sie können Personen auch manuell hinzufügen.

Erstelle Profile für jede Person, mit der du dich triffst

Versionsverfolgung

Verwenden Sie git. Git init in deinem Obsidian-Verzeichnis. Für alles andere verwenden wir Git, warum nicht unsere Wissensdatenbank? Verpflichten Sie sich am Ende eines jeden Tages und werfen Sie einen Blick auf das Diff. Schreiben Sie eine echte Commit-Nachricht. Mach dir keine Sorgen über die Länge. Für mich enthält es eine bessere Zusammenfassung meines Tages, als ich es sonst nirgendwo finden kann.
$ git log ist jetzt eine ziemlich gute Möglichkeit, um zu sehen, was Sie in einer Woche getan haben.

Stellen Sie einfach sicher, dass Sie eine .gitignore-Datei haben. In meinem Fall ignoriere ich mein eng-wiki-Verzeichnis, damit ich mich nicht mit git-Submodulen befassen muss.

Diagramme

Ein Bild sagt mehr als 1000 Worte. So mache ich Bilder.

Excalidraw

Es gibt ein Excalidraw-Plugin für Obsidian (danke @zsviczian!). Ich habe schon darüber geschrieben Wieviel ich Liebe Excalidraw. Die Tatsache, dass sich Obsidian elegant in Excalidraw integrieren lässt, ist erstaunlich. Wenn ich elegant sage, dann meine ich es auch. Sie können innerhalb von Diagrammen auf Seiten in Ihrer Wissensdatenbank verlinken. Sie können einbetten. Es ist großartig.

Excalidraw

Meerjungfrau

Excalidraw ist ein großartiges Allzweck-Diagrammwerkzeug. Aber für stark strukturierte Diagramme, Meerjungfrau ist manchmal besser. Obsidian bietet native Unterstützung für Mermaid-Diagramme. Erstellen Sie einfach einen Codeblock, der als “Meerjungfrau” bezeichnet wird.

Hier ist ein Beispiel aus ihren Dokumenten.


flowchart TD
  A[Start] --> B{Is it?};
  B -- Yes --> C[OK];
  C --> D[Rethink];
  D --> B;
  B -- No ----> E[End];

Meerjungfrau

Fragen

Jeden Tag werden 1.000.000 Fragen auftauchen. Es wird nicht immer Zeit sein, sie zu fragen. Einige davon können Sie nachschlagen. Ich empfehle, ein System für diese zu erstellen. Ich habe eine zentrale Fragenseite erstellt. Wenn auf anderen Seiten etwas auftaucht, verlinke ich auf meine Fragenseite. Auf diese Weise kann ich mir alle Backlinks ansehen, wenn ich offene Fragen überprüfen möchte. Tags funktionieren auch.

Schauen Sie sich täglich offene Fragen an. Sehen Sie sich das Firmen-Wiki oder andere Quellen der Wahrheit an. Wenn Sie die Antwort finden, aktualisieren Sie den Link von [[question]] zu [[answered-question]] und fügen Sie die Antwort mit einem beliebigen Hyperlink zu vorhandenen Inhalten in die Wissensdatenbank ein. Zum Beispiel, [[answered-question]] what's the protocol for opening PRs into other teams' repos? Answer: [[eng-wiki/code-review-process]] goes into this.

Bei Fragen, die Sie nicht selbst beantworten können, filtern Sie sie nach denjenigen, die wichtig sind und die Ihr Team beantworten kann, und Slack sie jeden Tag massenhaft. Stellen Sie sicher, dass die Antworten in Ihre Wissensdatenbank zurückkehren.

Tägliche Notizen

Tagesnotiz

Obsidian hat einen Plugin für tägliche Notizen das ist sehr nützlich. Morgens als erstes erstelle ich eine tägliche Notiz, gebe meine Google-Kalenderagenda ein (Hyperlink zu allen, mit denen ich mich treffe). Ich füge immer einen „Meta“-Abschnitt für Beobachtungen darüber ein, wie das System mir dient. Ich empfehle auch, Links zu erstellen, die auf die nächster und vorheriger Tag.

Ich finde, dass tägliche Notizen eine Menge zufälliger Dinge ansammeln, die an diesem Tag auftauchten. Nehmen Sie sich ein wenig Zeit und fragen Sie sich, ob Inhalte auf der täglichen Notizseite verschoben werden sollen.

Karten

Jede Aufgabe, die Ihnen in Ihrem Produktmanagement zugewiesen wird, könnte zumindest frühzeitig auch in Ihrem persönlichen Notizsystem nachverfolgt werden. Es ermöglicht Ihnen, auf relevante Dokumente zu verlinken, Notizen zu machen, Statusaktualisierungen zu erstellen, Fragen zu sammeln, Diagramme zu erstellen usw.

Fahrkarte

Mein Ticketverzeichnis ist nicht flach. Meine sieht so aus:


tickets
├── closed
│   ├── POP-696.md
│   └── POP-698.md
└── open
    └── POP-700.md

Die Unterscheidung zwischen offen und geschlossen hilft beim Standup, wenn Sie Ihrem Team mitteilen möchten, wie das Ticket läuft.

Viele der Aufgaben, die Sie erledigen, wenn Sie neu im Job sind, sind eher Routineaufgaben. Sie bauen die Homepage in Woche eins nicht neu auf. Gibt es für diese wiederholbaren Aufgaben eine gute Dokumentation dazu? Wahrscheinlich nicht. Machen Sie ein Spielbuch. Das macht es beim nächsten Mal einfacher. Wenn Ihr Playbook etwas beschreibt, das über Sie und Ihr Team hinausgeht, fügen Sie es dem eng-weiten Wiki hinzu.

Retros, freies Schreiben und Synthese

Wenn Ihr Team Retros erstellt, empfehle ich, einige Zeit im Voraus zu planen, um frei zu schreiben. Auch wenn Ihr Team keine Retro-Tradition hat, ist es eine gute Idee, etwas Zeit für freie Reflexion einzuplanen – es fördert Synthese, Verbindungen und Verständnis.

Betrachten Sie es als Teil Ihrer Stellenbeschreibung, um die Entropie zu minimieren. Nachdem Sie das Knäuel Ihrer Organisation verstanden haben, können Sie es entwirren oder zumindest die Rate, mit der es sich verheddert, reduzieren. Sie können sich Analogien, Diagramme, Verbindungen einfallen lassen – alles, was das System besser in die Gehirne passt – Sie werden einen enormen Mehrwert schaffen. Hier ist ein großartiger Artikel über diese allgemeine Idee wie es für Forscher gilt. Sie nennen es Forschungsschulden. ich halte es für semantische Schulden oder kognitive Schuld. Reflektierendes Schreiben ist eine gute Möglichkeit, Ihr Gehirn auf die Synthese vorzubereiten.

Wenn du nachdenklich schreibst. Machen Sie sich keine Sorgen um Formatierung und Verlinkung, während Sie frei schreiben, es könnte den Fluss behindern. Wenn Sie fertig sind, sehen Sie nach, ob es Links zum Hinzufügen oder Formatieren zum Übernehmen gibt.

*Es hilft nicht, dass ich Prosopagnosie habe!

Dieser Artikel von Nacheinander ist ein Gedankenstrom über Computer. Der Autor Zeke Nierenberg schreibt über Programmierung, Bildung, technologiegestützte Denkwerkzeuge und Produktentwicklung. Finden Sie den Originalartikel Hier.


Source: The Next Web by thenextweb.com.

*The article has been translated based on the content of The Next Web by thenextweb.com. If there is any problem regarding the content, copyright, please leave a report below the article. We will try to process as quickly as possible to protect the rights of the author. Thank you very much!

*We just want readers to access information more quickly and easily with other multilingual content, instead of information only available in a certain language.

*We always respect the copyright of the content of the author and always include the original link of the source article.If the author disagrees, just leave the report below the article, the article will be edited or deleted at the request of the author. Thanks very much! Best regards!