من دفتر برنامه فناوری های باز Postman’s را رهبری می کنم – دفتر برنامه منبع باز ما (OSPO). تیم من عمدتاً از مشارکت کنندگان منبع باز تشکیل شده است و سازمان مادر ما، Postman Open Technologies، یک مرکز رشد برای فناوری API و یک اتاق فکر استراتژی است. گروهی از متخصصان برجسته صنعت وجود دارند که من با آنها و برای آنها کار می کنم، و برای تغییر جهان دائماً بین سندرم فریبکار و توهمات عظمت جابه جا می شوم.
در جلسه اخیر تیم Postman Open Technologies، من یک جهت کلی ارائه دادم و گفتم که ما باید تیمی باشیم که برای مستندسازی شناخته شده است و باید همه چیز را به صورت فردی و همچنین در یک تلاش تیمی مستند کنیم. در حالی که زمینه بیشتری وجود داشت، مانند همکاری ما با تیم‌های محصول، این یک توصیه کلی است که من به خودم و دیگران در صنعتمان می‌دهم – به ویژه در این زمینه‌های کاری: مهندسی، OSPOها و روابط توسعه‌دهنده.
اما ابتدا بیایید اصطلاح “اسناد” را تعریف کنیم. در زمینه این پست وبلاگ، مستندات شامل مستندات فنی خارجی و داخلی، وبلاگ نویسی، اشتراک گذاری دانش در شبکه های اجتماعی، دموها، مقالات نحوه انجام، دستورالعمل ها، جلسات کنفرانس، وبینارها، پادکست ها، ویکی ها، اینفوگرافیک ها، نمودارهای جریان و مانند.
من درک می‌کنم که در دنیای پرشتاب امروز، گم شدن در مسئولیت‌ها چقدر آسان است. اما در حالی که برای نوشتن اسناد فوراً مانند نوشتن کد، راه‌اندازی یک فرآیند یا حل یک مشکل پاداشی دریافت نمی‌کنید، ایجاد مستندات خوب به معنای ابراز همدردی با اطرافیان و همچنین خود آینده‌تان است. تأثیر آن میان مدت و بلندمدت است، اما اکنون نیاز به اولویت بندی دارد.
10 دلیل اصلی من که چرا عالی بودن در مستندسازی کلید موفقیت است
شما باید به عنوان فردی که در مستندسازی فراتر می رود شناخته شوید زیرا:
-
مستندسازی شما را به یک همکار و همکار بهتر تبدیل می کند. ایجاد مستندات خوب، ناامیدی را کاهش می دهد، سطح اضطراب همکاری را کاهش می دهد و تصمیمات قبلی را قابل درک تر می کند.
-
مستندسازی ارزش شما را افزایش می دهد. این ارزش شما را به عنوان یک حرفه ای افزایش می دهد و باعث می شود کمتر هزینه کنید. رها کردن شخص یا تیمی که بخش خوبی از دانش درونی را ایجاد کرده است، آسیب می‌زند. توجيه كردن كسي كه به ايجاد دانش پايدار معروف است آسانتر است.
-
مستندسازی به ساختن برند شخصی شما کمک می کند. در هنگام انجام تحقیق، بارها و بارها با یک نام نویسنده مشابه مواجه شوید، شما را به یک متخصص موضوع تبدیل می کند. چند معیار دیگر را اضافه کنید – مانند مشارکت در جامعه، راهنمایی، سخنرانی در جمع، هر آنچه که انتخاب می کنید – به برند شما کمک زیادی می کند.
-
مستندسازی باعث ایجاد دید داخلی می شود. اینکه بتوانید به چیزی که نوشته اید ارجاع دهید، راحت تر از تکرار مبهم آن چیزی است که در یک جلسه تیم گفته اید یا نظر داده اید. اگر انجام این کار آسان باشد، احتمال بیشتری وجود دارد که همکاران اعتباری را به شما بدهند.
-
شما می توانید برش و تاس در تولید محتوا. هنگامی که شروع به مستند کردن چیزها کردید، می توانید آن را برای ایجاد محتوا برش دهید و قطعه قطعه کنید. تولید یک ویدیو، نوشتن یک روایت پادکست، آماده کردن یک سخنرانی، یا دعوت از افراد با نظرات مشابه یا متفاوت به یک پانل بسیار ساده تر از شروع از صفر است. همچنین به شما کمک می کند تا یک نخ قرمز برای خود پیدا کنید داستان سرایی، که یکی دیگر از موارد این لیست است.
-
مستندسازی به درونی کردن دانش شما کمک می کند. و هشدارها را شناسایی کنید. تکرار، مغز انسان اینگونه کار می کند. نوشتن چیزی دقیقاً همین است. هنگامی که انگشتان شما در تایپ کردن کندتر از مغز شما در پردازش اطلاعات هستند، شما آن را مجبور می کنید که همان کار را بارها و بارها تکرار کند. این به شما کمک می کند یافته ها را درونی کنید یا به شما کمک می کند تا اشکالات و اشکالات فکری خود را پیدا کنید.
-
مستندسازی باعث تداوم دانش شما می شود. واضح ترین، اما در عین حال نادیده گرفته ترین نکته در لیست من. آیا تا به حال به نوشته ای برخورد کرده اید و فکر کرده اید، سلام، این دانش خوبی است، خوشحالم که شخص دیگری آن را یادداشت کرده است! فقط فهمیدی دو سال پیش تو بودی؟ ما فراموش می کنیم و این حتی بخشی از فرآیند یادگیری ماست. ذخیره اطلاعات نه تنها کاری است که شما برای دیگران انجام می دهید بلکه برای خودتان نیز انجام می دهید. و حتی اگر به طور منظم محتوای خود را به روز نکنید، برای مدت معینی و شاید حتی بیشتر از آن مفید خواهد بود. (سلب مسئولیت: این بهانه خوبی برای به روز نگه نداشتن اسناد شما نیست!)
-
مستندسازی باعث صرفه جویی در زمان می شود. آیا برعکس فرض می‌کردید که نوشتن اسناد زمان زیادی را می‌خورد؟ آیا تا به حال احساس کرده اید که می خواهید خودتان را تکرار کنید؟ احتمالاً به این دلیل است که شما این کار را کردید. وقتی مستندات را می نویسید، شما را از کار خسته کننده توضیح مکرر به دیگران نجات می دهد. وقتی سومین بار را صرف توضیح چیزی می‌کنید، بهتر است وقتتان را صرف نوشتن آن می‌کنید. شما هنوز هم می‌توانید آن بحث را با همسالان خود داشته باشید، اما آن را در سطح دیگری خواهید داشت.
-
مستندسازی به جلوگیری از ناهنجاری درخواست کردن کمک می‌کند. این فقط شما نیستید که حوصله شما را از توضیح دادن همان چیز قدیمی برای سومین بار در این هفته احساس می کنید. همچنین آنها احساس بدی دارند که وقت شما را تلف می کنند. همکاران ممکن است از درخواست شما خودداری کنند زیرا احساس می کنند زمان شما بسیار با ارزش است. این مانع از همکاری می شود.
-
مستندسازی شما را در داستان سرایی بهتر می کند. تصویر بزرگتر چیزی است که از شما خواسته می شود. اینکه بتوانید نه تنها حقایق و ارقام را ارائه دهید، بلکه یک روایت را نیز توسعه دهید و اعداد را به ذهن دیگران بچسبانید، بسیار ارزشمند است.
توجه به این نکته مهم است که در حالی که من می گویم “مستندات خوب”، من “عالی” یا “ممتاز” را نمی خواهم. این به این دلیل نیست که من فکر می کنم هیچ چیز هیچ وقت کامل نخواهد بود. به این دلیل است که اسناد همیشه نباید بکر باشند. اغلب به اندازه کافی، “مستندات متوسط” کار را انجام می دهد و یک سازش قانونی بین تلاش و سود است.
هر زمان که اولویت بندی اسناد را در نظر می گیرید، که شامل تولید محتوای داخلی و خارجی می شود، قطعاً همیشه باید پاسخ دهید: “بله، خواهم کرد.”
پست 10 دلیلی که چرا باید در مستندسازی تجاوز کنید اولین بار در وبلاگ پستچی ظاهر شد.
