Dokumen yang berbeda seperti itu: desain vs. berorientasi pada pengguna

Pekerjaan seorang penulis teknis didedikasikan untuk penulis teknis Rusia favorit saya - untuk membuat dokumen untuk produk perangkat lunak, pada dasarnya semua jenis manual pengguna. Mengembangkan dokumen tidaklah mudah. Ada banyak pendekatan dan praktik. Misalnya, penulis teknis di perusahaan ilmiah dan industri sering kali menulis sesuai dengan GOST atau standar domestik lainnya. Tujuan mereka adalah mendeskripsikan produk secara akurat dan akurat. Dan penulis teknis di perusahaan internasional menulis sesuai dengan panduan gaya (Microsoft Manual of Style, misalnya). Dalam hal ini, tujuannya lebih untuk menyampaikan kepada pengguna bagaimana produk bekerja. Di sini fokus dialihkan dari produk ke pembaca.



Saya pernah menjadi penulis teknologi di berbagai tempat, dengan aturan dan kebijakan yang berbeda. Melihat ke belakang, saya dapat mengatakan bahwa bahkan di lembaga penelitian, teks dapat diorientasikan kembali ke pengguna akhir, dan dokumen akan mendapat manfaat dari ini. Tapi di GOST mereka tidak menulis tentang itu. Dan panduan gaya, pertama, dalam bahasa Inggris, dan kedua, mereka tidak diiklankan di kantor domestik seperti NPP, KB, dll. Oleh karena itu, jelas ada kekurangan informasi. Saya akan mencoba untuk mengisinya.



Apa perbedaan dok untuk produk Yandex, Google, Microsoft, Apple dari dokumentasi jadul yang dibuat oleh insinyur desain?



Insinyur klasik menulis agar produk dijelaskan selengkap dan seakurat mungkin + sesuai dengan GOST dan terminologi yang diterima. Selain itu, banyak istilah dan definisi di GOST sudah ketinggalan zaman dan tidak mewarnai dokumen sama sekali. Tapi ini bukan masalah bagi konstruktor - tidak ada yang berpikir jika teks mudah dipahami oleh pengguna. Tetapi dok yang dibuat untuk orang-orang berbeda: dok dibuat dalam bahasa yang dapat dimengerti dan mempertimbangkan minat pengguna. Masalah prioritas.



Prioritas dan tujuan penulis tersebut sangat mempengaruhi dokumen apa saja yang diperoleh. Mari kita lihat dengan contoh tampilannya dalam kehidupan nyata:





Kebetulan Anda melihat dokumen, dan secara moral sudah ketinggalan zaman. Ini seperti membaca instruksi untuk traktor tahun 1950-an. Kita perlu membuatnya lebih relevan, tetapi tampaknya tidak mungkin. Faktanya, segalanya mungkin. Dalam artikel berikut, saya akan menganalisis langkah demi langkah bagaimana tepatnya untuk beralih dari kumpulan dokumentasi besar yang sudah ketinggalan zaman ke dermaga modern yang ringan dan dapat dimengerti. Kami akan menganalisis setiap poin dalam tabel di artikel terpisah.