Halaman ini berisi detail project penulisan teknis yang diterima untuk Google Season of Docs.
Ringkasan project
- Organisasi open source:
- TheGoodDocsProject
- {i>Technical writer <i}(Penulis teknis):
- Loquacity
- Nama proyek:
- Panduan arsitektur informasi
- Durasi project:
- Durasi standar (3 bulan)
Project description
Rencana Panduan Arsitektur Informasi
Dokumen ini membahas perencanaan panduan arsitektur informasi untuk Project Good Docs. Dokumen ini disiapkan sebagai bagian dari kiriman Google Season of Docs 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 cara konten diatur. Gaya bahasa mencakup struktur konten tanpa menentukan gaya atau kata-kata yang digunakan dalam konten itu sendiri. Misalnya, rencana IA akan mempertimbangkan siapa pembaca, bagaimana mereka mengakses konten, dan lingkungan tempat mereka membaca. Kemudian, Chromebook akan mempertimbangkan struktur yang sesuai untuk konten yang paling sesuai dengan kebutuhan pembaca tersebut.
Dalam kondisi ideal, dokumentasi dirancang dengan memulai dari strategi konten, yang menggunakan sasaran bisnis untuk menentukan sasaran dokumentasi. Strategi konten kemudian digunakan untuk membuat IA, yang menentukan tata letak dan struktur dokumentasi. Dari sana, toolchain dapat dipilih, dan konten dapat ditulis. Kenyataan dari sebagian besar project open source adalah strategi kontennya sesederhana "tulis beberapa dokumentasi agar orang tahu cara menggunakan project ini", tetapi strategi sederhana tersebut sudah cukup untuk dapat menentukan IA yang efektif.
Tujuan panduan ini adalah untuk menyediakan alat yang disederhanakan bagi penulis non-profesional untuk mengembangkan IA yang memadai untuk menentukan template yang harus mereka gunakan. Prosesnya harus cukup sederhana untuk diselesaikan oleh manusia biasa dalam satu sore, dan harus lebih mengutamakan tindakan daripada pendidikan. Idealnya, artikel ini akan memperkenalkan konsep dengan cara yang ringkas, memandu pembaca untuk mempertimbangkan konsep tersebut sehubungan dengan project mereka sendiri, dan menggunakan hasilnya untuk melanjutkan ke konsep berikutnya.
Sebagai scaffolding untuk project ini, beberapa pembaruan pada README project 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 template The Good Docs Project untuk membuat dokumentasi project mereka
Kasus penggunaan: Bagian ini dirancang untuk mempelajari cara pembaca menggunakan Panduan IA. Hal ini dapat membantu kami mengidentifikasi bagaimana panduan harus disusun agar dapat melayani pembaca tersebut dengan sebaik mungkin.
Skenario:
Seorang pengguna sedang mengerjakan project open source yang memiliki sedikit atau tidak ada dokumentasi, atau suite dokumentasi yang disusun atau ditulis dengan buruk. Ia memutuskan untuk menggunakan The Good Docs Project untuk mengatur dokumentasi, tetapi tidak yakin harus memulai dari mana. Mereka mengikuti README untuk memahami cara memulai template, dan mengikuti Information Architecture Guide untuk mengembangkan strategi konten dan merencanakan tampilan suite dokumentasi mereka.
Proposal
Perbarui README untuk memandu pembaca baru melalui project dengan lebih jelas, termasuk langkah pertama yang jelas. Salah satu langkah pertamanya adalah membaca dan menjawab pertanyaan dalam Panduan IA baru. Panduan tersebut akan mengajak pembaca untuk mempertimbangkan audiens, skema konten, matriks pengguna/tugas, dll., tanpa membebani pembaca terlalu banyak untuk mempelajari/memahami apa itu hal-hal tersebut dalam arti akademis. Setelah tugas ini selesai, pembaca akan memahami template 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 memahaminya dan buku ini telah menjadi dasar dari banyak konten yang telah saya tulis dan akan saya gunakan, tetapi juga karena buku ini sangat mudah dipahami dan dibaca oleh orang-orang yang baru mengenal IA jika mereka memiliki minat lebih lanjut. Dalam hal ini, ini adalah obat gateway IA.
Draf Daftar Isi
BACA:
-- Introduction to The Good Docs Project |_ 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 mulai menulis |_ Siapa yang membaca dokumen? |_ Mengapa mereka membaca dokumen? |_ Menulis untuk pembaca
Panduan IA:
-- Pengantar |_ Apa itu IA? |_ Mengapa saya harus peduli? -- Identifikasi kekacauan -- Nyatakan niat Anda -- Hadapi kenyataan -- Pilih arah -- Ukur jarak -- Mainkan struktur -- Bersiaplah untuk menyesuaikan