This site is not complete. The work to converting the volumes of സര്‍വ്വവിജ്ഞാനകോശം is on progress. Please bear with us
Please contact webmastersiep@yahoo.com for any queries regarding this website.

Reading Problems? see Enabling Malayalam

ഡോക്കുമെന്റേഷന്‍

സര്‍വ്വവിജ്ഞാനകോശം സംരംഭത്തില്‍ നിന്ന്

09:10, 13 ജൂണ്‍ 2008-നു ഉണ്ടായിരുന്ന രൂപം സൃഷ്ടിച്ചത്:- Technoworld (സംവാദം | സംഭാവനകള്‍)

ഉള്ളടക്കം

ഡോക്കുമെന്റേഷന്‍

Documentation

ഒരു കംപ്യൂട്ടര്‍-സംഗ്രഥിത സംവിധാനത്തിന്റെ വികാസത്തേയും അത് എങ്ങനെ ഉപയോഗിക്കാം എന്നതിനേയും വ്യക്തമായി സൂചിപ്പിക്കുന്ന മാര്‍ഗരേഖ. സിസ്റ്റം നിര്‍മിക്കപ്പെട്ട രീതി, അതിലെ ഘടകഭാഗങ്ങളുടെ പ്രവര്‍ത്തനം എന്നിവയെ സംബന്ധിച്ച പൂര്‍ണ വിവരങ്ങള്‍ രേഖപ്പെടുത്തിവയ്ക്കുന്നത് ഡോക്കുമെന്റേഷനിലൂടെയാണ്. ഉപയോക്താവ്, സിസ്റ്റം പ്രോഗ്രാമിങ്, നിര്‍ദേശ നിര്‍വഹണം (command execution) എന്നീ വ്യത്യസ്ത മേഖലകളിലെ സമഗ്ര വിവരണമാണ് ഡോക്കുമെന്റേഷനിലൂടെ സാധാരണയായി ലഭ്യമാകുന്നത്.

ലേഖന സംവിധാനം

ക. പ്രധാന ലക്ഷ്യങ്ങള്‍

1. ഇന്റര്‍ടാസ്ക്/ഇന്റര്‍ഫേസ് വാര്‍ത്താവിനിമയം

2. സമയാധിഷ്ഠിത തുടര്‍രേഖകള്‍

3. ഗുണനിലവാര നിയന്ത്രണം

4. നിര്‍ദേശക രേഖകള്‍

കക. വര്‍ഗീകരണം

1. അനലിറ്റിക്കല്‍ ഡോക്കുമെന്റേഷന്‍

2. സിസ്റ്റംസ് ഡോക്കുമെന്റേഷന്‍

3. പ്രോഗ്രാം ഡോക്കുമെന്റേഷന്‍

4. ഓപ്പറേഷന്‍സ് ഡോക്കുമെന്റേഷന്‍

5. യൂസെര്‍ ഡോക്കുമെന്റേഷന്‍

കകക. കാലാനുഗതമാറ്റങ്ങള്‍

പ്രധാന ലക്ഷ്യങ്ങള്‍

ഡോക്കുമെന്റേഷന് പ്രധാനമായി നാലു ലക്ഷ്യങ്ങള്‍ നിര്‍വഹിക്കേണ്ടിവരാറുണ്ട്.


ഇന്റര്‍ടാസ്ക്/ഇന്റര്‍ഫേസ് വാര്‍ത്താവിനിമയം

ഓരോ ഘട്ടത്തിലും പൂര്‍ത്തീകരിക്കുന്ന പ്രവര്‍ത്തനങ്ങളെ സൂചിപ്പിക്കുന്നതോടൊപ്പം അനന്തര നടപടികള്‍ ആസൂത്രണം ചെയ്യാന്‍ സഹായിക്കുന്ന മാര്‍ഗനിര്‍ദേശങ്ങളും ഇതില്‍ ഉള്‍പ്പെടുത്താറുണ്ട്. വിഭവ സമാഹരണം, ഇന്‍വെന്‍ട്രി കണ്‍ട്രോള്‍, ഷെഡ്യൂളിങ്, പുരോഗതി വിലയിരുത്തല്‍, ജോബ് അനാലിസിസ്, മാര്‍ക്കറ്റ് സ്റ്റഡി, സെയില്‍സ് ഫോര്‍കാസ്റ്റിങ് തുടങ്ങിയവയെല്ലാം ഇതിലുള്‍പ്പെടുന്നു. പ്രോജക്റ്റില്‍ നിന്ന് ഒരാള്‍ പിരിഞ്ഞുപോയാല്‍ അയാള്‍ ഏറ്റു നടത്തിയിരുന്ന പണി വിശകലനം ചെയ്യാനും പകരം വരുന്ന ആളിന് തുടര്‍ ചുമതല ഏല്‍ക്കാനും ഡോക്കുമെന്റേഷന്‍ അന്ത്യന്തം സഹായകമാണ്.

സമയാധിഷ്ഠിത തുടര്‍രേഖകള്‍

കാലാനുഗതമായു ണ്ടാകുന്ന ഗുണ വൃദ്ധിയും തദനുസാര മാറ്റങ്ങളും സിസ്റ്റത്തില്‍ ഉള്‍പ്പെടുത്തണമെങ്കില്‍ സിസ്റ്റത്തിന്റെ പരിണാമപര സംക്രമത്തെ സംബന്ധിച്ച് വ്യക്തമായ അറിവുണ്ടായിരിക്കണം. സിസ്റ്റത്തിലെ എല്ലാ ഭാഗങ്ങളുടേയും പ്രവര്‍ത്തനം, അന്യോന്യ വിനിമയം എന്നിവയെപ്പറ്റി വ്യക്തമായ ധാരണ ആവശ്യമാണ്. സിസ്റ്റത്തില്‍ സമയാധിഷ്ഠിതമായി നടത്തേണ്ടി വരുന്ന അറ്റകുറ്റപ്പണികള്‍ നിര്‍വഹിക്കാനും ഇത്തരം അറിവ് ഉപകരിക്കുന്നു. പ്രോഗ്രാം എഴുതിയ ആള്‍ പിരിഞ്ഞുപോയശേഷം വരുന്ന സിസ്റ്റം പ്രോഗ്രാമര്‍ക്ക്, പ്രോഗ്രാമിലെ യുക്തി ഗ്രഹിക്കാന്‍, ഡോക്കുമെന്റേഷനെ ആശ്രയിക്കുകയേ നിര്‍വാഹമുള്ളൂ. ഇതിന്റെ അഭാവം പുതിയ ഡിസൈന്‍ നടപ്പിലാക്കുന്നതു ദുഷ്കരമാക്കും.

ഗുണനിലവാര നിയന്ത്രണം

ഡോക്കുമെന്റേഷന്‍ പരിശോധിച്ച്, സിസ്റ്റത്തിന്റെ ഗുണ വൃദ്ധിയുടേയും തദനുസൃത പ്രചാരത്തിന്റേയും അതിനെടുത്ത സമയാന്തരങ്ങളുടേയും ഘട്ടം ഘട്ടമായ വിശകലനത്തിലൂടെയാണ്, മാനേജ്മെന്റ് സിസ്റ്റത്തിനെ വിലയിരുത്തുന്നത്.

നിര്‍ദേശക രേഖകള്‍

സിസ്റ്റത്തിന്റെ പ്രവര്‍ത്തനത്തെ സംബന്ധിച്ച വിശദാംശങ്ങള്‍ സിസ്റ്റത്തിന്റെ ഗുണമേന്മകള്‍, സമയ ബന്ധിതമായ വളര്‍ച്ചകള്‍ എന്നിവയെക്കുറിച്ചുള്ള വിവരണമാണ് ഇവ ഉള്‍ക്കൊള്ളുന്നത്.

സിസ്റ്റത്തിന്റെ കൂടെ ലഭ്യമാവുന്ന ലാങ്ഗ്വേജ് മാനുവലുകള്‍, കംപ്യൂട്ടര്‍ ഭാഷകളെക്കുറിച്ചുള്ള പ്രതിപാദ്യം, ഓപ്പറേറ്റിങ് സിസ്റ്റം മാനുവലുകള്‍, സബ്റുട്ടീനുകള്‍, ആപ്ലിക്കേഷന്‍, യൂട്ടിലിറ്റി പാക്കേജുകള്‍ മുതലായവ ഇതിനുള്ള ഉദാഹരണങ്ങളാണ്.

വര്‍ഗീകരണം

ഡോക്കുമെന്റേഷനെ പൊതുവേ അഞ്ചായി തരംതിരിക്കാം: 1. അനലിറ്റിക്കല്‍ ഡോക്കുമെന്റേഷന്‍, 2. സിസ്റ്റംസ് ഡോക്കുമെന്റേഷന്‍, 3. പ്രോഗ്രാം ഡോക്കുമെന്റേഷന്‍, 4. ഓപ്പറേഷന്‍സ് ഡോക്കുമെന്റേഷന്‍, 5. യൂസെര്‍ ഡോക്കുമെന്റേഷന്‍.


അനലിറ്റിക്കല്‍ ഡോക്കുമെന്റേഷന്‍

ഉപയോക്താക്കള്‍ ക്ക് പലപ്പോഴും അവരുടെ ആവശ്യങ്ങള്‍ വസ്തുനിഷ്ഠമായി നിര്‍വചിക്കാനാവില്ല. ഉദാരഹരണമായി, ബില്ല് തയ്യാറാക്കി നല്‍കാനുള്ള ഒരു കംപ്യൂട്ടര്‍ സോഫ്റ്റ് വെയെറിന്റെ സാധ്യതയെക്കുറിച്ചുള്ള അന്വേഷണവുമായിട്ടാണ് ഉപയോക്താവ് വരുന്നത് എന്നു കരുതുക. പ്രൊഫോര്‍മ ഇന്‍വോയിസ്, ക്യാഷ് ബില്ല് തുടങ്ങിയവയെക്കുറിച്ചെല്ലാം ഉപയോക്താവ് ബോധവാനായിരിക്കണമെന്നില്ല. ഇത്തരം സന്ദര്‍ഭങ്ങളില്‍ സോഫ്റ്റ് വെയെര്‍ എന്‍ജിനീയര്‍ ഉപയോക്താവുമായി വിശദമായ ചര്‍ച്ചയില്‍ ഏര്‍പ്പെട്ടശേഷം സിസ്റ്റത്തിന് ആവശ്യമുള്ള ഇന്‍പുട്ട് ഡേറ്റ, ഔട്ട്പുട്ടുകള്‍ എന്നിവ ഏതൊക്കെയാണെന്നു നിശ്ചയിച്ചുറപ്പിക്കുന്നു. തുടര്‍ന്ന് ഇതിനെ പ്രോഗ്രാമിങ്ങിലൂടെ പ്രാവര്‍ത്തികമാക്കുന്നതിന് ഒരു ബാഹ്യ ചട്ടക്കൂട് തയ്യാറാക്കുന്നു. അതിനുശേഷം ഇതിനായി ആവശ്യമുള്ള വിഭവസമാഹരണത്തിന്റെ തോത്, പദ്ധതി ആസൂത്രണം ചെയ്ത് നടപ്പാക്കാന്‍ വേണ്ടിവരുന്ന സമയം എന്നിവയെക്കുറിച്ചുള്ള വിശദാംശങ്ങള്‍ സമാഹരിക്കുന്നു. ഉപയോക്താവിനെ ഇവയെക്കുറിച്ചെല്ലാം ബോധ്യപ്പെടുത്തുന്നതോടൊപ്പം അവയുടെ ഡോക്കുമെന്റേഷന്‍ കൂടി തയ്യാറാക്കുന്നു. ഇവയുടെ അടിസ്ഥാനത്തിലാണ് സിസ്റ്റം ഡിസൈനും, പ്രോഗ്രാമിങ്ങും നടത്തുന്നത്. പില്‍ക്കാല ആവശ്യങ്ങള്‍ക്ക്, മേല്‍ സൂചിപ്പിച്ച മുന്‍ കാര്യങ്ങളുടെ വസ്തുനിഷ്ഠ വിവരണം ലഭിക്കുന്നതും, ഇത്തരം അനലിറ്റിക്കല്‍ ഡോക്കുമെന്റേഷനിലൂടെ മാതമാണ്.

സിസ്റ്റംസ് ഡോക്കുമെന്റേഷന്‍

സോഫ്റ്റ് വെയെറില്‍ ഉപയോഗിക്കുന്ന പ്രോഗ്രാമിങ് നടപടികള്‍, അവ പരീക്ഷിക്കപ്പെടുന്ന രീതികള്‍, അവ നടപ്പാക്കുന്നതിനുള്ള ക്രമീകരണങ്ങള്‍ തുടങ്ങി സോഫ്റ്റ് വെയെര്‍ പ്രോഗ്രാമിന്റെ പ്രവര്‍ത്തന രീതികളെപ്പറ്റിയുള്ള സമഗ്രമായൊരു വിവരണമാണ് സിസ്റ്റംസ് ഡോക്കുമെന്റേഷന്‍ നല്‍കുന്നത്. വിശ്ലേഷണ ഡിസൈന്‍ രീതികളെക്കുറിച്ചുള്ള പരാമര്‍ശം സിസ്റ്റംസ് ഡോക്കുമെന്റേഷനില്‍ ഉള്‍ക്കൊള്ളിക്കുന്നു. പ്രോഗ്രാമില്‍ പിശകുകള്‍ കണ്ടെത്തിയാല്‍ പരിഹരിക്കുന്നതിനും, പുതിയ ഹാര്‍ഡ് വെയെര്‍, സോഫ്റ്റ് വെയെര്‍ എന്നിവയെ അവലംബിച്ച് പ്രവര്‍ത്തനം ക്രമീകരിക്കുന്നതിനും സിസ്റ്റംസ് ഡോക്കുമെന്റേഷന്‍ പരിശോധിക്കേണ്ടി വരും. ഓരോ കമ്പനിക്കും അവരുടേതായ രീതിയില്‍ സിസ്റ്റംസ് ഡോക്കുമെന്റേഷന്‍ നടപ്പിലാക്കാം; അല്ലെങ്കില്‍ എസ്എസ് എഡിഎം (സ്ട്രക്ചേഡ് സിസ്റ്റംസ് അനാലിസിസ് ആന്‍ഡ് ഡിസൈന്‍ മെത്തേഡ്) പോലെ വ്യാപകമായി ലഭ്യമാകുന്ന ഏതെങ്കിലും മാനദണ്ഡം സ്വീകരിക്കാം. പ്രോഗ്രാം തയ്യാറാക്കുമ്പോള്‍ ഏതെല്ലാം തലത്തില്‍ ഏതേതു വിധത്തിലുള്ള ഡോക്കുമെന്റേഷന്‍ എങ്ങനെ നല്‍കാനാവും എന്നു വിശദമാക്കുന്ന രൂപരേഖകളാണിവ. കൂടാതെ കംപ്യൂട്ടര്‍ എയിഡഡ് സോഫ്റ്റ് വെയെര്‍ എന്‍ജിനീയറിങ് ടൂളുകളും (CASE tools) ഇതിനായി ഇന്ന് വിപണിയില്‍ ലഭ്യമാണ്.

ഡേറ്റാ എലിമെന്റുകളുടെ പ്രതിനിധാനം, അവ തമ്മിലുള്ള പരസ്പര ബന്ധങ്ങള്‍, ഡേറ്റാഫ്ളൊ, സിസ്റ്റം ഫ്ളൊച്ചാര്‍ട്ട് എന്നി വയെക്കുറിച്ചെല്ലാം സിസ്റ്റംസ് ഡോക്കുമെന്റേഷന്‍ വ്യക്തമായ അറിവ് നല്‍കണം. ഇതിനായി പ്രോഗ്രാമര്‍ പലതരത്തിലുള്ള ഫ്ളോച്ചാര്‍ട്ട് ചിഹ്നങ്ങളും ഉപയോഗിക്കാറുണ്ട്.

പ്രോഗ്രാം ഡോക്കുമെന്റേഷന്‍

സോഫ്റ്റ് വെയെറിലെ മൊത്തം പ്രോഗ്രാമിങ് മോഡ്യൂളുകളുടെ വികാസത്തേയും അവ തമ്മിലുള്ള പ്രതിക്രിയകളേയും വിശദമാക്കുന്ന ഡോക്കുമെന്റേഷ നാണിത്. ഓരോ മോഡ്യൂളും തയ്യാറാക്കിയ വ്യക്തി, ഡേറ്റകള്‍ നിര്‍വചിക്കപ്പെട്ടിരിക്കുന്ന രീതി, പ്രോഗ്രാം വിലയിരുത്താന്‍ ഉപയോഗിച്ച ടെസ്റ്റ് ഡേറ്റ മുതലായവയെക്കുറിച്ചുള്ള സമഗ്രവിവരങ്ങള്‍ ഇതിലൂടെ ലഭ്യമാക്കേണ്ടതുണ്ട്. ഇതിനായി വിവിധ സംവിധാനങ്ങള്‍ നിവവിലുണ്ട്. പ്രോഗ്രാം ലോജിക് വ്യക്തമാക്കുന്ന സ്യൂഡൊ-കോഡ് ആദ്യം തയ്യാറാക്കുന്നു. അതിനെ അടിസ്ഥാനമാക്കിയുള്ള പ്രോഗ്രാം ഫ്ളൊചാര്‍ട്ടില്‍ നിന്ന്, ഏതെങ്കിലും ഒരു കംപ്യൂട്ടര്‍ ഭാഷയില്‍ പ്രോഗ്രാം എഴുതുമ്പോള്‍, കമന്റുകളും ഉള്‍പ്പെടുത്തേണ്ടതാണ്. പ്രോഗ്രാമിലെ ചരങ്ങള്‍ക്ക് അര്‍ഥസംപുഷ്ടമായ വാക്കുകള്‍ തിരഞ്ഞെടുക്കുന്നതാണ് ഉത്തമം. ഉദാഹരണമായി, ഒരു പേറോള്‍ പ്രോഗ്രാമില്‍ തൊഴിലാളിയുടെ അടിസ്ഥാന ശമ്പളത്തെ A എന്നു സൂചിപ്പിക്കുന്നതിനു പകരം BASIC PAY അഥവാ BAPAY എന്ന രീതിയില്‍ സൂചിപ്പിക്കുന്നത് പിന്നീട് പ്രോഗ്രാം വായിക്കുന്നവര്‍ക്ക് സൗകര്യപ്രദമാവും. അതുപോലെ പ്രോഗ്രാമിലെ ഡു/ഫോര്‍/ തുടങ്ങിയ ലൂപ്പുകള്‍ മറ്റു പ്രോഗ്രാം വരികളെ അപേക്ഷിച്ച് അല്പം വലത്തോട്ടു മാറ്റി എഴുതിയാല്‍ പെട്ടെന്ന് ശ്രദ്ധയില്‍പ്പെടുത്താന്‍ കഴിയും. പ്രോഗ്രാം ശരിയായി പ്രവര്‍ത്തിക്കാന്‍ ആവശ്യമായ ഹാര്‍ഡ് വെയെര്‍/സോഫ്റ്റ് വെയെര്‍ ക്രമീകരണങ്ങളെക്കുറിച്ചും ഇതില്‍ പ്രതിപാദ്യമുണ്ടാവാം.

പ്രോഗ്രാം ഡോക്കുമെന്റേഷന്റെ വിവിധ തലങ്ങള്‍ ചാര്‍ട്ടില്‍ വ്യക്തമാക്കിയിരിക്കുന്നു. ഒരു പ്രോഗ്രാം സ്യൂഡോ-കോഡും അതിന്റെ പ്രോഗ്രാം ഫ്ളൊചാര്‍ട്ടും യഥാക്രമം a,b എന്നിവയില്‍ സൂചിപ്പിച്ചിട്ടുണ്ട്:

ചിത്രം:P83.png‌‌

Image:p84a1.png

ഓപ്പറേഷന്‍സ് ഡോക്കുമെന്റേഷന്‍

സിസ്റ്റം പ്രവര്‍ത്തിപ്പിക്കാന്‍ നല്‍കേണ്ട നിര്‍ദേശങ്ങളുടെ വിവരണമാണിത്. ഡേറ്റ തയ്യാറാക്കാനുള്ള നടപടിക്രമങ്ങള്‍, ഡേറ്റയെ സംരക്ഷിക്കാനുള്ള രീതികള്‍, ഔട്ട്പുട്ട് ക്രമീകരണം, ഇതര നിര്‍ദേശങ്ങള്‍ എന്നിവയെല്ലാം ഇതിലുണ്ടായിരിക്കും.

യൂസര്‍ ഡോക്കുമെന്റേഷന്‍

സൗകര്യപ്രദമായി സോഫ്റ്റ് വെയര്‍ ഉപയോഗിക്കാനുള്ള വഴികള്‍ ഉപയോക്താവിന് വ്യക്തമാക്കിക്കൊടുക്കുന്ന ഡോക്കുമെന്റേഷനാണിത്. ഹാര്‍ഡ് വെയറുകള്‍ സജ്ജീകരിക്കേണ്ടരീതി, പ്രോഗ്രാം ലോഡ് ചെയ്യല്‍, ചോദ്യങ്ങള്‍ സിസ്റ്റത്തിലേക്ക് നല്‍കേണ്ട രീതി, ഔട്ട്പുട്ടിനെക്കുറിച്ചുള്ള വിശകലനം തുടങ്ങിയവയെല്ലാം യൂസെര്‍ ഡോക്കുമെന്റേഷനില്‍ പ്രതിപാദിക്കപ്പെടണം. വിപണിയിലെത്തുന്ന സോഫ്റ്റ് വെയെറുകളെ ഉപയോക്താവ് ഏതു തരത്തില്‍ സ്വീകരിക്കുന്നു എന്നതിനെ സ്വാധീനിക്കുന്ന പ്രധാനഘടകം കൂടിയാണിത്. സിസ്റ്റത്തിന്റെ പ്രവര്‍ത്തനത്തെ വിശദമാക്കുന്ന ട്യൂട്ടോറിയല്‍ പ്രോഗ്രാമുകളും ഇവയില്‍പ്പെടുന്നു.

കാലാനുഗത മാറ്റങ്ങള്‍

ഡോക്കുമെന്റേഷന്‍ സഹിതം സോഫ്റ്റ് വെയെര്‍ വിപണിയിലെത്തിയാലും കാലാനുഗതമായി സിസ്റ്റത്തില്‍ മാറ്റങ്ങള്‍ വരുത്തേണ്ടിവരാം. ഇത്തരത്തില്‍ സിസ്റ്റത്തില്‍ വരുന്ന മാറ്റങ്ങളെ സംബന്ധിച്ചുള്ള പൂര്‍ണ വിവരങ്ങള്‍ ഉള്‍പ്പെടുത്തി പുതിയ ഡോക്കുമെന്റേഷന്‍ പുറത്തിറക്കണം. ഓരോ പ്രാവശ്യം മാറ്റം വരുമ്പോഴും അതിനെ സൂചിപ്പിക്കുന്ന ഡോക്കുമെന്റേഷനും തയ്യാറാക്കപ്പെടുന്നു. സിസ്റ്റത്തിന്റെ ഏറ്റവും പുതിയ അവസ്ഥയെ വ്യക്തമാക്കുന്നതാവണം അതിന്റെ ഡോക്കുമെന്റേഷന്‍. സിസ്റ്റത്തിന് സമൂലമായ മാറ്റം വരുത്തുമ്പോള്‍ അതിന്റെ നിലവിലുള്ള ഡോക്കുമെന്റേഷന്‍ വിപണിയില്‍ നിന്ന് പിന്‍വലിക്കേണ്ടത് അത്യാവശ്യമാണ്.

താളിന്റെ അനുബന്ധങ്ങള്‍
സ്വകാര്യതാളുകള്‍