Ta strona zawiera szczegółowe informacje na temat projektu technicznego przyjęta do programu Sezon Dokumentów Google.
Podsumowanie projektu
- Organizacja open source:
- TheGoodDocsProject
- Pisarz techniczny:
- Wysokość
- Nazwa projektu:
- Przewodnik po architekturze informacji
- Długość projektu:
- Standardowa długość (3 miesiące)
Opis projektu
Przewodnik po architekturze informacji
Ten dokument dotyczy planowania przewodnika po architekturze informacyjnej dla projektu Good Docs. Został on opracowany w ramach zgłoszenia dotyczącego sezonu Dokumentów Google 2020. Wskazuje on przypadek użycia zaproponowanego przewodnika oraz szkic jego struktury na potrzeby planowania.
Architektura informacyjna dotyczy sposobu organizacji treści. Obejmują strukturę treści bez określania stylu i słów w samej treści. Na przykład plan IA uwzględnia to, kim jest czytelnik, jakie podejście do treści podchodzi do treści i jakie jest środowisko, w którym czyta treści. Warto wtedy zastanowić się nad taką strukturę treści, która najlepiej spełnia te wymagania czytelnika.
W idealnym świecie opracowanie dokumentacji zaczyna się od strategii dotyczącej treści, która określa cele dokumentu na podstawie celów biznesowych. Następnie strategia dotycząca treści jest wykorzystywana do stworzenia IA, który określa układ i strukturę dokumentacji. Z tego poziomu można wybrać łańcuchy narzędzi i zapisać treść. W rzeczywistości w przypadku większości projektów open source strategia dotycząca treści jest tak prosta jak „napisanie dokumentacji, aby ludzie wiedzieli, jak korzystać z tego projektu”, jednak nawet ta prosta strategia wystarczy do zdefiniowania skutecznej strategii IA.
Celem tego przewodnika jest uproszczenie narzędzia dla zawodowych pisarzy do opracowania IA, która wystarczy do określenia, których szablonów użyć. Zadanie powinno być na tyle proste, aby zwykły człowiek mógł je zrealizować w popołudnie, a nie edukacja. Najlepiej, gdy wprowadza ona koncepcje w sposób zwięzły, podpowiada im je w odniesieniu do własnego projektu i wykorzystują uzyskane wyniki do przejścia do kolejnego pomysłu.
W ramach tego projektu należy wprowadzić pewne zmiany w pliku README, aby ułatwić czytelnikom rozpoczęcie korzystania z projektu Good Docs Project i umożliwić efektywne korzystanie z przewodnika IA, ułatwiając wybór szablonów.
Główni odbiorcy
Wszystkich osób, które chcą korzystać z szablonów projektu Good Docs Project, aby tworzyć dokumentację swojego projektu.
Przypadki użycia: ta sekcja ma na celu wyjaśnienie, jak czytelnicy podchodzą do Przewodnika IA. To pomoże nam ustalić, jak powinien wyglądać przewodnik, aby jak najlepiej pomagać czytelnikom.
Scenariusz:
osoba pracuje nad projektem open source, który ma mało dokumentacji lub nie ma jej wcale, albo pakiet dokumentacji, który jest źle zorganizowany lub napisany. Decydują się na organizację pracy z Good Docs Project, ale nie wiedzą, od czego zacząć. Zapoznają się z artykułem README, aby dowiedzieć się, jak zacząć korzystać z szablonów, i zastosują się do tych wytycznych: Information Architecture Guide, aby opracować strategię dotyczącą treści i zaplanować, jak będzie wyglądał pakiet dokumentacji.
Oferta pakietowa
Zaktualizuj plik README, aby pomóc nowemu czytelnikowi wykonać projekt, w tym jasno poprowadzić go przez pierwsze kroki. Jednym z tych pierwszych kroków jest przeczytanie pytań i udzielenie odpowiedzi w nowym przewodniku dotyczącym IA. Czytelnik powinien wziąć pod uwagę odbiorców, schemat treści, macierze użytkowników/zadań itp. bez nadmiernego obciążania czytelnika przyswajania informacji i rozumienia tych zagadnień z perspektywy akademickiej. Po ukończeniu tego zadania czytelnik wie, jakie szablony są wymagane i jak najlepiej je wykonać.
Zbieranie informacji
Aby poprzeć te badania, w dużym stopniu posługuję się książką Abby Covert (http://www.howtomakesenseofanimess.com/), częściowo dlatego, że znam ją bardzo dobrze i stworzyła podstawę dla wielu treści, które już napisałam i z których zamierzam korzystać, ale także dlatego, że osobom, które dopiero zainteresują się IA, bardzo łatwo je czytać. W tym sensie to taki narkotyk IA.
Warunki korzystania z usługi w wersji roboczej
README:
– Wprowadzenie do projektu Good Docs |_ Kto powinien korzystać z szablonów |_ Jak działają szablony |_ Udział w projekcie -- Szablony |_ Lista wszystkich bieżących szablonów |_ Wybór szablonów |_ Zanim zaczniesz -- Zanim zaczniesz pisać |_ Kto czyta dokumenty? |_ Dlaczego czytają dokumenty? |_ Treści dla czytelników
Przewodnik IA:
-- Wprowadzenie |_ Co to jest IA? |_ Dlaczego to jest ważne? - Identyfikacja bałaganu -- Wyraź swoje intencje -- Rzeczywistość twarz -- Wybierz kierunek -- Pomiar odległości -- Baw się strukturą - Przygotuj się do zmiany