داکیومنت نویسی چیست ؟

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

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

در این مقاله داکیومنت نویسی را بصورت کامل توضیح داده ایم پس با ما همراه باشید :

داکیومنت نویسی چیست ؟

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

نکات و قوانین داکیومنت نویسی

جامع و کامل

شما باید همه جوانب پروژه را در داکیومنت شرح دهید زمانیکه مستندات شما جامع و کامل باشد موجب سردرگمی و ایجاد ابهام نمی شود یعنی باید پاسخگوی سوالات خواننده باشد .

بروزبودن مستندات

بروز بودن و بروز نگه داشتن مستندات کمی کار دشواریست اما این مسئله بسیار مهم است . گاهی ممکن است شما در حین انجام پروژه بخش ها یا مسائل جدید به ذهنتان خطور بکند و تایم کوتاهی تا تحویل پروژه باقی نمانده باشد به همین دلیل بروز نگه داشتن کمی دشوار است .

جستجو پذیر

مستندات را باید به گونه ای بنویسید که موضوعات خاص و موردعلاقه را کاربر ، بتواند براحتی جستجو و پیدا کند.

گویا و واضح

یک مستند خوب باید واضح باشد و برای بیان موضوع از کلمات و جملات ساده استفاده کرد بصورتیکه تمام مراحل و بخش های مستند از قلم نیفتد .

خاصیت مشارکتی

یک مستند بروز و عالی باید خاصیت مشارکتی داشته باشد یعنی به گونه ای باشد که developer ها بتوانند در آینده آنها را ویرایش یا اصلاح و حذف کنند .

روان بودن

داکیومنت باید روان و سریع و خوانا باشد از پیچیدگی کلمات و جملات بپرهیزید . از عناوین مفید و مناسب و لینک های متفاوت در داکیومنت استفاده کنید که باعث مرور سریع و روان خوانی برای خواننده شود .

ثبت تاریخ و زمان

تاریخی که شروع به داکیومنت نویسی کردید و همچنین تاریخ مرحله به مرحله فرآیند های انجام شده داکیومنت را ، ذکر کنید .

مهمترین الزامات داکیومنت نویسی

همان طور که همه روند مراحل یک پروژه قوانین و الزاماتی دارد ، داکیومنت نویسی هم دارای قوانین و الزماتی است که به بهبود داکیومنت شما کمک میکند .

مهمترین الزامات داکیومنت نویسی به شرح زیر است :

حرفه ای بودن شما را بیان می کند

داکیومنت یا مستندات به مشتریان و نیروهای شما بیان می کند که به حفظ و نگهداری اطلاعات پایبند و متعهد هستید و در صورت لزوم اطلاعات دقیق و درست را در اختیار آنها قرار می دهید .

سود آوری در کسب وکار را افزایش می دهد

مستندسازی فرآیندها و اطلاعات ، منجر به پاسخگویی تمام سوالات کارمندان می شود که این امر باعث صرفه جویی در وقت و هزینه شرکت می شود .

برای بهبود عملکرد راهنمایی می کند

بایگانی اسناد و مدارک باید مرحله به مرحله انجام شود زیرا در وقت و هزینه وعملکرد شرکت ، تاثیر بسزایی دارد .

ویژگی های داکیومنت نویسی چیست ؟

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

بهترین روش داکیومنت نویسی ALOCA-C

روش داکیومنت نویسی ALOCA-C مخفف کلمات Attributable ، Legible ، Original ، Contemporaneous ، Accurate ، Complete یکی از بهترین روش هایی داکیومنت نویسی است که هر کدام از این موارد یکی از جوانب نوشتن یک داکیومنت خوب را بیان میکند . که در زمان نوشتن داکیومنت پروژه خود باید رعایت کنید تا مطمئن شوید از کیفیت لازم برخوردار است .

Attributable

مستنداتی که شما می‌نویسید باید خیلی سریع قابل‌ شناسایی باشند. وقتی داکیومنت شما این ویژگی مهم را نداشته باشد مستندات شما کیفیت لازم را ندارد و قابل استناد نیست . اگر شخصی مستندات و داکیومنت شما را بخواند باید به‌ سرعت متوجه شود که چه کسی آن را ایجاد و چه کسی آن را توسعه داده است .

Legible

Legible به معنی قابل خواندن است ، این اصل به نحوه نوشتن و خوانایی مستند اشاره دارد . شما درمهارت نویسندگی باید بسیار حرفه ای باشید و مطالب ، مستند را باید واضح و گویا بنویسید که مخاطب با خواندن مطالب موضوع را درک کند .

Contemporaneous

این اصل نحوه نوشتن شما را بیان می کند که باید تمام مستندات را بصورت همزمان بنویسید . از ابتدای شروع انجام یک پروژه مرحله به مرحله باید داکیومنت را بنویسید .

Accurate

اصل دقیق بودن ( Accurate ) برای توصیف جملاتی به کار برده می شود که هیچ خطا و اشتباهی ندارد . یعنی تمام رویه ها که برای توسعه و ذخیره انجام میشود باید دقیق و ساده باشد .

Complete

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

منبع florencehc.com

جمله پایانی

شما برای معرفی و آشنایی با پروژه خود باید یک مستند کامل و جامع تهیه کنید و کل فرآیندهای پروژه را به گونه ای بیان کنید که خواننده تمام سوالات ذهنی اش برطرف شود . داکیومنت شما باید براساس واقعیات نوشته شود تا همه به این موضوع پی ببرند که در اصل نگهداری و حفط مستندات متعهد هستید .

تیم کیهان وب در تمام پروژه های خود تمامی این اصول داکیومنت نویسی را رعایت میکند تا نیاز های مشتری را به خوبی پیدا کند و آن را در پروژه به بهترین شکل ممکن اجرا کند .