Halaman ini berisi detail project penulisan teknis yang diterima untuk Google Season Dokumen.
Ringkasan proyek
- Organisasi open source:
- TheGoodDocsProject
- Penulis teknis:
- Lokuitas
- Nama proyek:
- Panduan arsitektur informasi
- Durasi proyek:
- Durasi standar (3 bulan)
Project description
Rencana Panduan Arsitektur Informasi
Dokumen ini meliputi perencanaan panduan arsitektur informasi untuk Proyek Google Dokumen yang Baik. Dokumen ini disiapkan sebagai bagian dari pengiriman Google Season Dokumen 2020. Dokumen ini menguraikan kasus penggunaan untuk panduan yang diusulkan, dan membuat sketsa rencana struktur panduan tersebut, untuk tujuan perencanaan.
Arsitektur informasi (IA) berkaitan dengan bagaimana konten diatur. Hal ini mencakup struktur konten tanpa menentukan gaya atau kata-kata yang digunakan dalam konten itu sendiri. Misalnya, rencana IA akan mempertimbangkan siapa pembaca, bagaimana mereka melakukan pendekatan terhadap konten, dan lingkungan tempat mereka membaca. Selanjutnya, tim akan mempertimbangkan struktur yang sesuai untuk konten yang paling memenuhi persyaratan pembaca ini.
Idealnya, dokumentasi dirancang dengan memulai dengan strategi konten, yang menggunakan sasaran bisnis untuk menentukan sasaran dokumentasi. Strategi konten kemudian digunakan untuk membuat IA, yang mendefinisikan tata letak dan struktur dokumentasi. Dari sana, toolchain dapat dipilih, dan konten ditulis. Kenyataan sebagian besar proyek {i>open source<i} adalah bahwa strategi konten itu sesederhana "menulis beberapa dokumentasi agar orang tahu cara menggunakan proyek ini", tetapi strategi sederhana itu pun cukup untuk dapat mendefinisikan IA yang efektif.
Tujuan panduan ini adalah untuk menyediakan alat yang disederhanakan bagi penulis non-profesional untuk mengembangkan IA yang memadai untuk menentukan {i>template<i} mana yang harus mereka gunakan. Video harus cukup sederhana untuk diselesaikan oleh orang biasa di sore hari, dan sebaiknya lebih mengutamakan tindakan daripada pendidikan. Idealnya, Anda akan memperkenalkan konsep secara ringkas, memandu pembaca untuk mempertimbangkan konsep-konsep tersebut dalam kaitannya dengan proyek mereka sendiri, dan menggunakan hasilnya untuk beralih ke konsep berikutnya.
Sebagai petunjuk untuk proyek ini, beberapa pembaruan pada README proyek diperlukan, sehingga pembaca memahami cara memulai Project Dokumen yang Baik, dan dapat menggunakan panduan IA secara efektif untuk memandu pilihan template mereka.
Audiens utama
Semua orang yang ingin menggunakan {i>template<i} The Good Docs Project untuk membuat dokumentasi proyek mereka
Kasus penggunaan: Bagian ini dirancang untuk mempelajari pendekatan pembaca terhadap Panduan IA. Hal ini dapat membantu kita mengidentifikasi bagaimana panduan disusun untuk memberikan layanan terbaik kepada pembaca.
Skenario:
Seseorang sedang mengerjakan project open source yang memiliki sedikit atau tanpa dokumentasi sama sekali, atau rangkaian dokumentasi yang tidak terorganisir atau ditulis dengan baik. Mereka memutuskan untuk menggunakan The Good Docs Project untuk mengatur dokumentasi mereka, tetapi tidak yakin dari mana harus memulai. Mereka mengikuti README untuk memahami cara mulai menggunakan template, dan mengikuti Information Architecture Guide untuk mengembangkan strategi konten dan merencanakan tampilan suite dokumentasi mereka.
Proposal
Perbarui README untuk memandu pembaca baru melalui proyek dengan lebih jelas, termasuk langkah pertama yang jelas. Salah satu langkah pertama adalah membaca dan menjawab pertanyaan-pertanyaan dalam Panduan IA yang baru. Panduan tersebut akan mengajak pembaca untuk mempertimbangkan audiens, skema konten, matriks pengguna/tugas, dll., tanpa membebani pembaca untuk mempelajari/memahami hal-hal tersebut secara akademis. Setelah tugas ini selesai, pembaca memiliki pemahaman tentang {i>template<i} apa yang diperlukan, dan cara terbaik menyelesaikannya.
Riset
Untuk mendukung hal ini dengan riset, saya akan sangat mengandalkan buku Abby Covert (http://www.howtomakesenseofanymess.com/), sebagian karena saya sangat familier dengannya dan itu telah menjadi dasar dari banyak konten yang telah saya tulis dan akan digunakan, tetapi juga karena sangat mudah bagi orang yang baru mengenal IA untuk memahami dan membacanya lebih jauh. Dalam pengertian itu, ini adalah semacam obat {i>gateway IA<i}.
ToC draf
BACA:
-- Pengantar Proyek Dokumen yang Baik |_ Siapa yang harus menggunakan template |_ Cara kerja template |_ Berkontribusi pada proyek -- Template |_ Daftar semua template saat ini |_ Memilih template yang akan digunakan |_ Sebelum memulai -- Sebelum Anda mulai menulis |_ Siapa yang membaca dokumen? |_ Mengapa mereka membaca dokumen? |_ Menulis untuk pembaca Anda
Panduan IA:
-- Pengantar |_ Apa itu IA? |_ Mengapa saya harus peduli? -- Identifikasi berantakan -- Nyatakan maksud Anda -- Realitas wajah -- Pilih arah -- Ukur jarak -- Bermain dengan struktur -- Bersiaplah untuk menyesuaikan