من به مردم پول دادم تا سعی کنند README من را دنبال کنند

توسعه دهندگان از نوشتن مستندات بدشان می آید. ما دوست داریم RTFM بگوییم، اما اغلب هیچ FM برای R وجود ندارد. در بهترین حالت، مجموعه ای نیمه آماده از یادداشت ها، برخی نکات منسوخ، و پیوندی به یک انجمن متروک پر از افرادی داریم که بارها و بارها سؤالات مشابه را می پرسند. این راهی برای رفتار با کاربران ما نیست.

من ساده لوحانه معتقدم راه بهتری وجود دارد. همانطور که قبلا نوشتم، شما باید بنشینید و در واقع readme خود را تست کنید. یک ماشین مجازی تازه بچرخانید، آنچه را که نوشته اید مرور کنید و ببینید آیا منطقی است یا خیر.

اما نادیده گرفتن تعصبات خود واقعا سخت است. البته می‌دانید که دستورات خاصی نیاز به sudo دارند و بدیهی است که وقتی نوشتید -foo منظورتان -foo بود و همه می‌دانند که باید بعد از آن دوباره راه‌اندازی کنید.

چگونه می توانید از شر آن تعصبات خلاص شوید؟ من به مردم پول دادم!

به عنوان بخشی از درخواست کمک مالی NLnet برای ActivityBot، گفتم می‌خواهم تجربه نصب را با کاربران واقعی آزمایش کنم و آماده بودم برای یک ساعت از وقت آنها ۲۵ یورو بپردازم. تماس را در Mastodon قطع کردم، چند نفر را جمع کردم و با آنها تماس تصویری داشتم.

قالب ساده بود توضیح دادم که به دنبال بازخورد در مورد تجربه اول هستم. می‌دانستم که کامل نیست و فعالانه می‌خواهم انتقاد سازنده داشته باشم. من از داوطلب خواستم صفحه نمایش خود را به اشتراک بگذارد و مهمتر از همه، با صدای بلند صحبت کند. به من بگو چه کار می کردند. چه چیزی آنها را نفهمیدند، چه چیزی آنها را گیج کرد، چه چیزی آنها را خوشحال کرد، چه چیزی آنها را ناامید کرد و غیره.

من با دست یادداشت برداری کردم (لعنت به دستگاه تغذیه می کنم) و چندین ساعت وقت گذاشتم که به او گفته شود چه فرضیات نادرستی کرده ام.

بعد از هر جلسه، README را بر اساس آنچه که افراد مشکل می‌دانستند، به‌روزرسانی می‌کردم، سپس آن را با نفر بعدی دوباره آزمایش می‌کردم.

در مجموع حدود 150 یورو پرداخت کردم تا عده ای از من انتقاد کنند. سلام، ارزان تر از درمان، درست است؟

من می دانم که کسی می خواهد بگوید "چرا فقط از یک LLM نمی خواهیم طیف وسیعی از کاربران را شبیه سازی کند؟" پاسخ بسیار ساده است - من می خواهم با افراد واقعی صحبت کنم. مردم درخشان هستند! آن‌ها می‌توانند شما را بخندانند، می‌توانید گربه‌شان را در هنگام تماس مشاهده کنید، دیدگاه منحصربه‌فردی را برای مشکل به ارمغان می‌آورند، و وقتی به آنها کوپن ۲۵ یورویی می‌دهید، واقعا خوشحال می‌شوند. برخی با کمال میل این کار را به صورت رایگان انجام می دهند و شما را خوشحال می کنند!

زمانی که مشغول نوشتن فنی برای GOV.UK بودم، تمام نثرهای زیبای من توسط یک انسان دیگر مورد توجه قرار گرفت. آنها تمام عبارات گلدار من را از بین بردند و سند را به چیزی خواندنی تر تبدیل کردند. آنها کسانی بودند که اشتباهاتی را گرفتند که هیچ غلط گیر املای نتوانست. آنها توانستند گفتگوی مناسبی با من داشته باشند. مهمتر از آن، من می توانستم ناامیدی را در صدای آنها بشنوم - این چیزی است که به شما اجازه می دهد بدانید یک اشتباه باید اصلاح شود.

من ادعا نمی کنم که README ActivityBot اکنون کامل است - بسیار دور از آن - اما اکنون به وضوح قابل مشاهده است که دنبال کردن آن آسان تر است. توسعه دهندگان باید با افراد واقعی صحبت کنند. اگر توانایی پرداخت آن را ندارید، مجبور نیستید به آنها پول بدهید - اما چند نفر را پیدا کنید که در حالی که سعی می کنند دستورالعمل های شما را دنبال کنند، با صدای بلند صحبت کنند. من به شما تضمین می کنم که README شما برای آن بسیار بهتر خواهد شد.