ارائه اسد صفری با موضوع افسانه مستندسازی در پروژه‌های نرم‌افزاری در سومین همایش آینده وب و موبایل

1. ‫موبایل‬‫و‬‫وب‬‫آینده‬‫همایش‬|#FOWM
w w w . f o w m . i r
‫صفری‬ ‫اسد‬
@asadsafari
‫افزاری‬‫نرم‬ ‫های‬‫پروژه‬ ‫در‬ ‫مستندسازی‬ ‫افسانه‬

2. ‫پروژه‬ ‫مدیر‬‫نویس‬ ‫برنامه‬

3. ‫اول‬ ‫روز‬ ‫فردا‬ ‫بعد‬ ‫هفته‬ ‫یک‬

4. ،‫سازی‬ ‫مستند‬ ‫در‬ ‫اصل‬ ‫اولین‬
،‫نیست‬ ‫دیگران‬ ‫برای‬ ‫مستندات‬
‫است‬ ‫دهنده‬ ‫توسعه‬ ‫خود‬ ‫آن‬ ‫مشتری‬ ‫اولین‬

5. ‫و‬ ‫آب‬ ‫روی‬ ‫رفتن‬ ‫راه‬
‫افزاری‬ ‫نرم‬ ‫پروژه‬ ‫انجام‬
‫شده‬ ‫تعیین‬ ‫پیش‬ ‫از‬ ‫پلن‬ ‫طبق‬
‫است‬ ‫شدنی‬ ‫دو‬ ‫هر‬
‫که‬ ‫شرطی‬ ‫به‬
‫باشند‬ ‫زده‬ ‫یخ‬ ‫آنها‬ ‫دوی‬ ‫هر‬
‫آب‬ ‫هم‬ ‫و‬ ‫پلن‬ ‫هم‬
‫ندهد‬ ‫تغییر‬ ‫را‬ ‫آن‬ ‫کسی‬ ‫و‬

6. ‫هست‬ ‫افزاری‬ ‫نرم‬ ‫های‬ ‫پروژه‬ ‫در‬ ‫ثابت‬ ‫اصل‬ ‫تنها‬ ،‫تغییر‬
‫مستندات‬(‫تجاری‬ ،‫فنی‬)
‫شوند‬ ‫داشته‬ ‫روزنگه‬ ‫به‬ ‫دائم‬ ‫و‬ ‫شده‬ ‫ایجاد‬ ‫مرور‬ ‫به‬ ‫باید‬
‫کرد‬ ‫نخواهد‬ ‫مراجعه‬ ‫آن‬ ‫به‬ ‫کسی‬ ‫غیراینصورت‬ ‫در‬

8. ‫انتقال‬ ‫روش‬ ‫ترین‬ ‫کیفیت‬ ‫کم‬‫اطالعات‬‫مکاتبه‬ ‫طریق‬ ‫از‬
‫اطالعات‬ ‫انتقال‬ ‫روش‬ ‫ترین‬ ‫کیفیت‬ ‫با‬‫ارتباط‬ ‫دانش‬ ‫و‬
‫چهره‬-‫به‬-‫چهره‬‫است‬

9. ،‫تحلیل‬ ‫سند‬ ‫مستندات؛‬...‫کنید‬ ‫مکتوب‬ ‫را‬
‫را‬ ‫چهره‬ ‫به‬ ‫چهره‬ ‫روش‬ ‫کنید‬ ‫سعی‬ ‫انتقال‬ ‫برای‬ ‫اما‬
‫کنید‬ ‫انتخاب‬
‫نداریم‬ ،‫بخون‬ ‫خودت‬ ‫برو‬...

10. ‫جفتی‬ ‫نویسی‬ ‫برنامه‬
Pair programming
‫گروهی‬ ‫نویسی‬ ‫برنامه‬(‫موب‬)
Mob Programming
‫نیست‬ ‫مستندات‬ ‫با‬ ‫فقط‬ ‫دانش‬ ‫انتقال‬

11. ‫جفتی‬ ‫نویسی‬ ‫برنامه‬
‫پیرینگ‬ ‫ورتیکال‬ ‫حتی‬ ‫یا‬

12. ‫افزاری‬ ‫نرم‬ ‫پروژه‬ ‫یک‬ ‫مستند‬ ‫ترین‬ ‫اصلی‬
‫است‬ ‫پروژه‬ ‫کد‬ ‫سورس‬
‫تمیز‬ ‫کد‬

13. ‫میفهمه‬ ‫کامپیوتر‬ ‫که‬ ‫بنویسه‬ ‫کدی‬ ‫میتونه‬ ‫احمقی‬ ‫هر‬
‫میتون‬ ،‫خوب‬ ‫نویس‬ ‫برنامه‬ ‫یک‬ ‫تنها‬ ‫ولی‬‫ه‬‫بنویسه‬ ‫کدی‬
‫میفهمن‬ ‫ها‬ ‫انسان‬ ‫که‬
‫فاوولر‬ ‫مارتین‬

16. ،‫کثیف‬ ‫کد‬ ‫داری‬ ‫نگه‬ ‫قابلیت‬ ‫بردن‬ ‫باال‬
،‫نیست‬ ‫عاقالنه‬ ‫حجیم‬ ‫مستندسازی‬ ‫با‬
‫کدهاست‬ ‫کردن‬ ‫تمیز‬ ،‫قطعی‬ ‫حل‬ ‫راه‬

17. ‫شامل‬ ‫تمیز‬ ‫کدنویسی‬:
‫مناسب‬ ‫گذاری‬ ‫نام‬
‫و‬ ‫ها‬ ‫کالس‬ ‫گی‬ ‫وظیفه‬ ‫تک‬ ‫اصل‬ ‫رعایت‬...
‫کدها‬ ‫نکردن‬ ‫کپی‬
‫نوشتن‬ ‫کامنت‬ ‫بجای‬ ‫کد‬ ‫بودن‬ ‫دهنده‬ ‫توضیح‬ ‫خود‬
‫متدها‬ ‫و‬ ‫ها‬ ‫کالس‬ ‫نشدن‬ ‫چاق‬ ‫رعایت‬
‫اینترفیس‬ ‫از‬ ‫استفاده‬ ‫مثال‬ ‫مناسب‬ ‫طراحی‬
...

18. ‫مدیران‬ ‫به‬ ‫توصیه‬
،‫ها‬ ‫نویس‬ ‫برنامه‬ ‫توسط‬ ‫کدها‬ ‫کردن‬ ‫رفاکتور‬ ‫دلیل‬ ‫ترین‬ ‫اصلی‬
‫نیست‬ ‫فنی‬ ‫مسائل‬ ‫یا‬ ‫خوانایی‬ ‫یا‬ ،‫داری‬ ‫نگه‬ ‫قابلیت‬ ‫بردن‬ ‫باال‬
‫است‬ ‫اقتصادی‬ ‫مسئله‬ ‫دقیقا‬ ‫بلکه‬
‫یعنی‬ ‫کثیف‬ ‫کد‬
‫کندی‬–‫نارضایتی‬-‫نیرو‬ ‫ریزش‬...

19. ‫ها‬ ‫نویس‬ ‫برنامه‬ ‫به‬ ‫توصیه‬
‫توانایی‬ ‫شما‬ ‫که‬ ‫نیست‬ ‫این‬ ‫دلیل‬ ،‫باشید‬ ‫نوشته‬ ‫کثیف‬ ‫کد‬ ‫سال‬ ‫ده‬ ‫اگر‬
‫دارید‬ ‫تمیز‬ ‫کد‬
‫هستند‬ ‫بلد‬ ‫تئوریک‬ ‫دوستان‬ ‫اکثر‬
‫است‬ ‫الزم‬ ‫کار‬ ‫در‬ ‫تمرین‬

20. ‫تمرین‬ ‫کتاب‬

21. ‫است؟‬ ‫مستندسازی‬ ‫به‬ ‫نیازی‬ ‫آیا‬ ،‫بود‬ ‫تمیز‬ ‫کد‬ ‫اگر‬
‫شود‬ ‫می‬ ‫مستند‬ ،‫بدهد‬ ‫توضیح‬ ‫تواند‬ ‫نمی‬ ‫کد‬ ‫که‬ ‫چیزی‬ ‫هر‬
‫مثل‬
‫معماری‬–‫طراحی‬ ‫مهم‬ ‫های‬ ‫تصمیم‬–‫کانترک‬API‫درسها‬ ‫یا‬ ‫ها‬ ‫مصیبت‬ ‫و‬...

22. ‫کرد؟‬ ‫سازی‬ ‫مستند‬ ‫باید‬ ‫چگونه‬ ‫اما‬

23. ‫متنی‬ ‫مستندات‬ ‫از‬ ‫بهتر‬ ‫اشکال‬ ‫و‬ ‫تصاویر‬ ‫و‬ ‫ها‬ ‫مدل‬
،‫شوند‬ ‫می‬ ‫خوانده‬ ‫کمتر‬ ‫متنی‬ ‫مستندات‬
‫شوند‬ ‫نمی‬ ‫خوانده‬ ‫اصال‬ ‫یا‬

24. ‫بگیرید‬ ‫عکس‬ ‫بردها‬ ‫وایت‬ ‫از‬
‫دارید‬ ‫نگه‬ ‫خود‬ ‫ابزار‬ ‫در‬ ‫و‬
‫مثل‬Jira
‫نباشید‬ ‫ابزار‬ ‫برده‬

25. ‫کجاست؟‬ ‫اینجا‬

26. ‫کجاست؟‬ ‫اینجا‬

27. ‫کجاست؟‬ ‫اینجا‬

28. ‫کجاست؟‬ ‫اینجا‬

29. ‫کجاست؟‬ ‫اینجا‬

30. ،‫نکنید‬ ‫شروع‬ ‫جزئیات‬ ‫از‬ ‫مستندسازی؛‬ ‫در‬
‫رسید‬ ‫جز‬ ‫به‬ ‫کل‬ ‫از‬ ‫باید‬

31. System Level

32. Container
Level
(web applications, mobile apps,
desktop applications, databases,
file systems)

33. Component Level

34. ‫است؟‬ ‫خوب‬ ‫ما‬ ‫مستندات‬ ‫که‬ ‫بفهمیم‬ ‫کجا‬ ‫از‬
-‫کند؟‬ ‫می‬ ‫مراجعه‬ ‫آن‬ ‫به‬ ‫کسی‬ ‫آیا‬
-‫شود؟‬ ‫می‬ ‫دستگیرش‬ ‫چیزی‬ ‫کرد‬ ‫مراجعه‬ ‫اگر‬
-‫میرود؟‬ ‫جلو‬ ‫کار‬ ‫مستندات‬ ‫طبق‬ ‫آیا‬
-‫شود؟‬ ‫می‬ ‫روز‬ ‫به‬ ‫مستندات‬ ‫آیا‬

35. ‫است‬ ‫جدید‬ ‫نویس‬ ‫برنامه‬ ‫مستندات‬ ‫کیفیت‬ ‫برای‬ ‫تست‬ ‫بهترین‬
‫دهید‬ ‫بهبود‬ ‫را‬ ‫آن‬ ،‫بود‬ ‫گنگ‬ ‫او‬ ‫برای‬ ‫موجود‬ ‫مستندات‬ ‫اگر‬
‫کنید‬ ‫آپدیت‬ ‫موقع‬ ‫همان‬ ،‫داشت‬ ‫کمبود‬ ‫اگر‬
،‫نمیدادند‬ ‫توضیح‬ ‫مستندات‬ ‫یا‬ ‫کد‬ ‫که‬ ،‫داشت‬ ‫او‬ ‫سوالی‬ ‫هر‬
‫کنید‬ ‫اضافه‬ ‫موقع‬ ‫همان‬.

36. ،‫کند‬ ‫نمی‬ ‫مراجعه‬ ‫آن‬ ‫به‬ ‫کسی‬ ‫که‬ ‫دارید‬ ‫مستنداتی‬ ‫اگر‬
‫کنید‬ ‫حذف‬ ‫را‬ ‫آن‬
‫ارزش‬ ‫بی‬ ‫یا‬ ‫اضافه‬ ‫چیز‬ ‫هر‬ ‫حذف‬ ‫یعنی‬ ‫بودن‬ ‫ناب‬

37. ‫مستندسازی‬
‫مدرن‬
Specificatio
n by
Example
BDD

38. API

39. ‫خالصه‬:
•‫است‬ ‫دهنده‬ ‫توسعه‬ ‫خود‬ ‫مشتری‬ ‫اولین‬ ،‫نیست‬ ‫دیگران‬ ‫برای‬ ‫مستندات‬
•‫کنند‬‫می‬ ‫پیدا‬ ‫گسترش‬ ‫محصول‬ ‫عمر‬ ‫چرخه‬ ‫طی‬ ‫در‬ ‫مرور‬ ‫به‬ ‫مستندات‬
•‫جفتی‬ ‫نویسی‬ ‫برنامه‬ ‫مثال‬ ،‫نیست‬ ‫کاغذی‬ ‫مستندات‬ ‫فقط‬ ‫دانش‬ ‫انتقال‬ ‫راه‬ ‫تنها‬
•‫باشد‬ ‫داری‬ ‫نگه‬ ‫قابل‬ ‫و‬ ‫تمیز‬ ‫باید‬ ‫پس‬ ،‫است‬ ‫ما‬ ‫مستند‬ ‫ترین‬ ‫اصلی‬ ‫کد‬
•‫هستند‬ ‫مستندات‬ ‫نوع‬ ‫بهترین‬ ‫تصاویر‬
•‫است‬ ‫چهره‬ ‫به‬ ‫چهره‬ ‫ارتباط‬ ‫طریق‬ ‫از‬ ‫دانش‬ ‫انتقال‬ ‫راه‬ ‫بهترین‬
•‫ندارید‬ ‫نگه‬ ‫را‬ ‫مرده‬ ‫مستندات‬
•‫کنید‬ ‫امتحان‬ ‫را‬ ‫مستندسازی‬ ‫مدرن‬ ‫های‬ ‫روش‬

40. ‫تشکر‬ ‫با‬
‫صفری‬ ‫اسد‬
@asadsafari
Asad.safari@gmail.com
Scrum.ir