آموزش مستندات پروژه

[haricanboy]

سلام
از دوستان لطفاً هر کی اطلاعاتی داره بهم کمک کنه فوری
نمیدونم جای این سوال اینجاست یا نه اگه نیست عذر میخوام
من میخوام برای یه پروژه اسمبلی مستندات بنویسم تا حالا مستندات ننوشتم نمیدونم چطور شروع کنم روالش چطوریه
لطفاً بگین
1. مستندات یه پروژه شامل چه قسمتهایی هست؟
2. چطوری شروع میشه و چطوری تموم میشه؟
3. چه قسمتهایی از پروژه رو تو مستندات باید توضیح داد؟
(فوری)
لطفاً اگه فایل مستندات به عنوان مثال دارید اینجا بزارید یا خودتون یه مثال ساده و کوتاه بزنید
ممنون

[Delphi Coder]

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