Diese Seite enthält die Details zu einem Projekt für technisches Schreiben, das für die Google-Produktsaison von Google Docs akzeptiert wurde.
Projektzusammenfassung
- Open-Source-Organisation:
- TheGoodDocsProject
- Technischer Redakteur:
- Loquecity
- Projektname:
- Leitfaden zur Informationsarchitektur
- Projektdauer:
- Standarddauer (3 Monate)
Projektbeschreibung
Leitfaden zur Informationsarchitektur
In diesem Dokument wird die Planung eines Leitfadens zur Informationsarchitektur für das Good Docs-Projekt behandelt. Sie wurde im Rahmen der Einreichung für die Google-Festtagssaison 2020 vorbereitet. Zu Planungszwecken wird der Anwendungsfall für den vorgeschlagenen Leitfaden umrissen und ein Plan für die Struktur eines solchen Leitfadens skizziert.
Die Informationsarchitektur (IA) bezieht sich darauf, wie Inhalte organisiert werden. Sie deckt die Struktur des Inhalts ab, ohne den Stil oder die Wörter zu definieren, die im Inhalt selbst verwendet werden. Ein IA-Plan würde beispielsweise berücksichtigen, wer die Leser sind, wie sie den Inhalt angehen und in welcher Umgebung sie lesen. Dann sollte eine geeignete Struktur für die Inhalte in Betracht gezogen werden, die diesen Anforderungen der Leser am besten entspricht.
Im Idealfall beginnt die Dokumentation am Anfang einer Inhaltsstrategie, bei der anhand von Geschäftszielen die Ziele der Dokumentation definiert werden. Anhand der Inhaltsstrategie wird dann eine IA erstellt, die das Layout und die Struktur der Dokumentation definiert. Von dort aus können Toolchains ausgewählt und Inhalte geschrieben werden. Die Realität der meisten Open-Source-Projekte ist, dass die Inhaltsstrategie so einfach ist wie „Eine Dokumentation schreiben, damit die Leute wissen, wie dieses Projekt verwendet wird“, aber selbst diese einfache Strategie reicht aus, um eine effektive IA definieren zu können.
Dieser Leitfaden soll nicht-professionellen Autoren ein einfaches Tool zur Verfügung stellen, mit dem sie eine IA entwickeln können, mit der sie entscheiden können, welche Vorlagen sie verwenden sollen. Sie sollte so einfach sein, dass sie von einem gewöhnlichen Menschen am Nachmittag durchgeführt werden kann, und sie sollte Handlung gegenüber Bildung Vorrang geben. Im Idealfall werden Konzepte kurz und prägnant vorgestellt, die Lesenden werden darin geführt, diese Konzepte im Zusammenhang mit ihrem eigenen Projekt zu betrachten, und das daraus resultierende Ergebnis verwenden, um zum nächsten Konzept überzugehen.
Als Grundgerüst für dieses Projekt sind einige Aktualisierungen der Projekt-Readme-Datei erforderlich, damit die Lesenden die ersten Schritte mit dem Good Docs-Projekt verstehen und den IA-Leitfaden effektiv als Leitfaden für die Auswahl der Vorlagen verwenden können.
Hauptzielgruppe
Alle Personen, die mit den Vorlagen für das Good Docs-Projekt eine Dokumentation für ihr Projekt erstellen möchten
Anwendungsfälle: In diesem Abschnitt wird erläutert, wie die Lesenden an den IA-Leitfaden herangehen. So können wir besser nachvollziehen, wie der Leitfaden strukturiert sein sollte, um diesen Lesern den bestmöglichen Nutzen zu bieten.
Szenario:
Ein Nutzer arbeitet an einem Open-Source-Projekt mit wenig oder gar keiner Dokumentation oder an einem schlecht organisierten oder geschriebenen Dokumentationssuite. Sie beschließen, ihre Dokumentation mithilfe des Good Docs-Projekts zu organisieren, wissen aber nicht, wo sie anfangen sollen. Sie folgen der Readme-Datei, um die ersten Schritte mit den Vorlagen zu verstehen, und folgen den Information Architecture Guide, um eine Inhaltsstrategie zu entwickeln und zu planen, wie die Dokumentationssuite aussehen wird.
Angebot
Aktualisieren Sie die Readme-Datei, um den neuen Lesern verständlicher durch das Projekt zu führen, einschließlich klarer erster Schritte. Einer dieser ersten Schritte besteht darin, die Fragen in einem neuen IA-Leitfaden zu lesen und zu beantworten. Dieser Leitfaden würde den Leser dazu auffordern, die Zielgruppe, das Inhaltsschema, die Nutzungs-/Aufgabenmatrizen usw. zu berücksichtigen, ohne den Leser zu viel zu belasten, um diese Dinge im akademischen Sinn zu verstehen/zu verstehen. Sobald diese Aufgabe abgeschlossen ist, wissen die Lesenden, welche Vorlagen erforderlich sind und wie sie am besten ausgeführt werden.
Research
Um dies durch Recherchen zu untermauern, würde ich mich stark auf das Buch von Abby Covert (http://www.howtomakesenseofanymess.com/) stützen, teilweise, weil ich damit sehr vertraut bin und die Grundlage für viele Inhalte bildete, die ich bereits geschrieben habe und die ich verwenden werde, aber auch, weil es für Menschen, die neu in IA neu sind, sehr einfach ist, Interesse zu wecken und zu lesen, wenn sie weiteres Interesse haben. In diesem Sinne ist es eine Art IA-Gateway-Medikament.
Entwurf des Inhaltsverzeichnisses
Infodatei:
-- Einführung in das Good Docs-Projekt |_ Wer sollte die Vorlagen verwenden |_ Funktionsweise der Vorlagen |_ Einen Beitrag zum Projekt leisten -- Die Vorlagen |_ Liste aller aktuellen Vorlagen |_ Auswahl der Vorlagen |_ Bevor Sie beginnen -- Bevor Sie mit dem Schreiben beginnen |_ Wer liest die Dokumente? |_ Warum lesen sie die Dokumente? |_ Für Ihre Leser schreiben
IA-Leitfaden:
-- Einführung |_ Was ist IA? |_ Warum sollte ich mich dafür interessieren? -- Das Chaos erkennen -- Ihre Absicht formulieren -- Ihr Gesicht begegnen -- Richtung wählen -- Entfernung messen -- mit Struktur spielen -- Anpassung vorbereiten