Diese Seite wurde von der Cloud Translation API übersetzt.

TheGoodDocsProject-Projekt

Diese Seite enthält die Details zu einem Projekt für technische Angelegenheiten, das für die Google-Saison der Dokumente angenommen wurde.

Projektzusammenfassung

Open-Source-Organisation:: TheGoodDocsProject
Technischer Redakteur:: Loquacity
Projektname:: Leitfaden zur Informationsarchitektur
Projektdauer:: Standardlaufzeit (3 Monate)

Projektbeschreibung

Leitfaden für die Informationsarchitektur

In diesem Dokument wird die Planung eines Leitfadens für die Informationsarchitektur für das Good Docs-Projekt beschrieben. Sie wurde im Rahmen der Google Docs-Saison 2020 erstellt. Darin wird der Anwendungsfall für den vorgeschlagenen Leitfaden beschrieben und ein Plan für die Struktur eines solchen Leitfadens skizziert.

Die Informationsarchitektur (IA) bezieht sich darauf, wie Inhalte organisiert sind. Er deckt die Struktur der Inhalte ab, ohne den Stil oder die Wörter zu definieren, die in den Inhalten selbst verwendet werden. In einem IA-Plan würde beispielsweise berücksichtigt werden, wer die Lesenden sind, wie sie an den Inhalt herangehen und in welcher Umgebung sie lesen. Dann wird eine geeignete Struktur für die Inhalte festgelegt, die diesen Leseranforderungen am besten entspricht.

Im Idealfall beginnt die Erstellung von Dokumentationen mit einer Inhaltsstrategie, in der die Ziele der Dokumentation anhand von Geschäftszielen definiert werden. Anhand der Inhaltsstrategie wird dann eine IA erstellt, die das Layout und die Struktur der Dokumentation definiert. Dort können Toolchains ausgewählt und Inhalte geschrieben werden. Bei den meisten Open-Source-Projekten besteht die Inhaltsstrategie aus der einfachen Aufforderung: „Erstellen Sie eine Dokumentation, damit Nutzer wissen, wie sie dieses Projekt verwenden können.“ Doch selbst diese einfache Strategie reicht aus, um eine effektive IA zu definieren.

Dieser Leitfaden soll Laien ein vereinfachtes Tool zur Verfügung stellen, mit dem sie eine IA entwickeln können, die ausreicht, um zu bestimmen, welche Vorlagen sie verwenden sollten. Sie sollte einfach genug sein, um von einem normalen Menschen an einem Nachmittag abgeschlossen zu werden, und sollte mehr auf Aktionen als auf Informationen setzen. Idealerweise werden die Konzepte auf prägnante Weise eingeführt, die Leser werden dazu angeleitet, diese Konzepte in Bezug auf ihr eigenes Projekt zu betrachten, und das Ergebnis wird genutzt, um mit dem nächsten Konzept fortzufahren.

Als Gerüst für dieses Projekt sind einige Aktualisierungen der README-Datei des Projekts erforderlich, damit Leser wissen, wie sie mit dem Good Docs-Projekt beginnen und den IA-Leitfaden effektiv bei der Auswahl ihrer Vorlagen verwenden können.

Primäre Zielgruppe

Alle, die die Vorlagen von The Good Docs Project verwenden möchten, um Dokumentationen für ihr Projekt zu erstellen

Anwendungsfälle: In diesem Abschnitt wird untersucht, wie Leser den IA-Leitfaden nutzen. So können wir besser nachvollziehen, wie der Leitfaden strukturiert sein sollte, um diesen Lesern bestmöglich zu helfen.

Szenario: Eine Person arbeitet an einem Open-Source-Projekt, für das nur wenige oder gar keine Dokumentationen oder eine schlecht organisierte oder geschriebene Dokumentationssuite vorhanden ist. Er entscheidet sich für das „The Good Docs Project“, um seine Dokumentation zu organisieren, weiß aber nicht, wo er anfangen soll. Sie lesen die README-Datei, um zu erfahren, wie sie mit den Vorlagen beginnen können, und folgen der Information Architecture Guide, um ihre Inhaltsstrategie zu entwickeln und zu planen, wie ihre Dokumentationssuite aussehen soll.

Angebot

Aktualisieren Sie die README-Datei, um neue Leser klarer 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 anregen, Zielgruppen, Inhaltsschemata, Nutzer-/Aufgabenmatrizen usw. zu berücksichtigen, ohne ihn zu sehr zu belasten, diese Dinge in akademischem Sinne zu lernen oder zu verstehen. Sobald diese Aufgabe abgeschlossen ist, weiß der Leser, welche Vorlagen erforderlich sind und wie sie am besten ausgefüllt werden.

Research

Um dies mit meinen Recherchen zu untermauern, würde ich mich ziemlich auf Abby Coverts Buch (http://www.howtomakesenseofanymess.com/) stützen. Das liegt zum Teil daran, dass ich damit sehr vertraut bin und es die Grundlage für viele Inhalte bildet, die ich bereits geschrieben habe und die ich verwenden werde, aber auch, weil es für Nutzer, die mit der IA neu sind, leicht zu lesen und zu lesen ist, wenn sie weiteres Interesse haben. In diesem Sinne ist es ein Einstieg in die KI.

Entwurf der Inhaltsübersicht

Infodatei:

IA-Leitfaden:

-- Einführung |_ Was ist IA? |_ Warum sollte ich das tun? -- Das Chaos erkennen -- Absicht formulieren -- Wirklichkeit gegenüberstellen -- eine Richtung auswählen -- Entfernung messen -- Strukturen spielen -- Vorbereiten