مستندات نرم افزار [بایگانی]

mariamsaleh

شنبه 01 تیر 1387, 09:11 صبح

سلام
می خواستم بدانم آیا برای تهیه مستنداتی که تحویل برنامه نویس می شود،شکل استانداردی وجود دارد؟منظورم از مستندات شکل اینترفیسها،اینکه هر ،به عنوان مثالdbedit به کدام فیلد از کدام جدول وصل می شود،رویدادهای مختلف یک objectو functionیا procedureای که اجرا می کند،بانک داده و ارتباطات جداول و خلاصه هر آنچه مربوط به نرم افزار است،می باشد.

Elham_gh

شنبه 01 تیر 1387, 10:22 صبح

اگر از RUP methodology استفاده مي كنيد،Artifact مشخصي را RUP معرفي نكرده است. اگر يك prototype خوب داشته باشيد مدل كردن UI ضروري نيست. اما در غير اين صورت مي توانيد از State machine براي مدل كردن آن استفاده كنيد.مثل شكل زير:

http://barnamenevis.org/forum/attachment.php?attachmentid=19406&stc=1&d=1215021077
البته بعضي ها دوست دارند جزئيات بيشتري به مدلشان اضافه كنند . مثل:
http://barnamenevis.org/forum/attachment.php?attachmentid=19407&stc=1&d=1215021077

اما اگر بخواهيد همه مدلهايتان را با اين جزئيات مدل كنيد ، state machine هاي بسيار پيچيده اي خواهيد داشت. به جاي پياده سازي اين جزئيات با notation هاي UML ، بهتر است انها را به صورت توضيحات در مدلتان داشته باشيد.

براي اطلاعات بيشتر Navigation MAP را جستجو كنيد.

mariamsaleh

شنبه 01 تیر 1387, 10:58 صبح

Elham_gh

شنبه 01 تیر 1387, 11:35 صبح

ممنون از راهنمایی شما
راستشو بخواهید گیر من الان مستند کردن interfaceهاست.جزییات اونا رو هم می دونم.فقط نمی دونم چطوری و با چه فرمتی اونا رو نشون بدم.این کاری که ما کردیم یه جورایی از اولش غیر استاندارد بوده .برنامه نویس کنار دستمون بوده و هر چی می خواستیم با هم هماهنگ می کردیم.حالا کار تموم شده ولی مستندات نداریم.من فعلا در این مرحله فقط میخوام interfaceها رو مستند کنم!

توضيحات من هم در مورد مستند كردن interface ها بود!! هر State در State machine در مورد user interface شماست.مثلاHelp desc main screen يك فرم است.

اما اگر نمي خواهيد مطابق استانداردي جلو بريد و فقط مي خواهيد يك مستندي داشته باشد. پيشنهاد من اين است كه به ازاي هر فرم يك قسمتها رو در مستند خودتون داشته باشد:
تصوير فرم
فراخوانده شده از (نام فرمها يا منوهايي كه اين فرم را صدا مي زنند)
فراخواننده (فرمهايي كه توسط اين فرم صدا زده مي شود)
اجزاي پايگاه داده(نام جداول View ها يا Store procedure هاي وابسته ذكر مي شود)
تقسيمات فرم (نام دسته بندي ها با استفاده از frame يا tab يا هر كنترل ديگر)
اقلام فرم(نام اقلام اطلاعاتي فرم آورده مي شود. به ازاي هر نام ، بايد نوعش مشخص شود كه عددي است متني است يا...به كدام فيلد از كدوم Object پايگاه داده متناظر است)
فعاليتهاي فرم(نام كليدها و عملكردشان توضيح داده مي شود)
Business rule ها(در اين جا نام قوانين حااكم در فرم آورده مي شود. بعد مشخص مي كنيد در چه سطحي بايد validate شود: در سطح كليد ، سطح كنترل يا سطح فرم. اگر سطح كليد و كنترل است، مرتبط با كدام قلم فرم است، اگر سطح فرم است در كدام عمليات فرم validate مي شود و چه اقلام فرمي را درگير مي كند)

Modifier

دوشنبه 10 تیر 1387, 02:16 صبح

سلام علیکم

سلام میشه منبع خودتون رو معرفی کیند تا ما هم بخونیم ؟

و اگه میشه بیشتر توضیح بدید .

یا علی

Elham_gh

دوشنبه 10 تیر 1387, 12:59 عصر

بله . شرمنده كه خودم نگفتم:
Pitfalls using UML in RUP
از مستندات مرتبط با Sparx Enterprise Architect است.
اگر مايل باشين راجع به كل مقاله اينجا صحبت خواهم كرد.

Modifier

دوشنبه 10 تیر 1387, 16:51 عصر

باید مقاله ی جالبی باشه.

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

Elham_gh

چهارشنبه 12 تیر 1387, 09:44 صبح

در تاپيك جديدي اين مقاله رو شروع كردم

http://barnamenevis.org/forum/showthread.php?p=545760#post545760