ഡോക്യുമെന്റേഷൻ

പേപ്പർ, അല്ലെങ്കിൽ ഓൺ‌ലൈൻ, അല്ലെങ്കിൽ ഓഡിയോ ടേപ്പ് അല്ലെങ്കിൽ സിഡികൾ പോലുള്ള ഡിജിറ്റൽ അല്ലെങ്കിൽ അനലോഗ് മീഡിയയിൽ നൽകിയിരിക്കുന്ന ഒരു കൂട്ടം പ്രമാണങ്ങളാണ് ഡോക്യുമെന്റേഷൻ. ഉപയോക്തൃ ഗൈഡുകൾ, ധവളപത്രങ്ങൾ, ഓൺ-ലൈൻ സഹായം, ദ്രുത-റഫറൻസ് ഗൈഡുകൾ എന്നിവ ഉദാഹരണങ്ങളാണ്. പേപ്പർ (ഹാർഡ്-കോപ്പി) ഡോക്യുമെന്റേഷൻ കാണുന്നത് വളരെ കുറവാണ്. വെബ്‌സൈറ്റുകൾ, സോഫ്റ്റ്‌വേർ ഉൽപ്പന്നങ്ങൾ, മറ്റ് ഓൺ‌ലൈൻ അപ്ലിക്കേഷനുകൾ എന്നിവയിലൂടെ ഡോക്യുമെന്റേഷൻ വിതരണം ചെയ്യുന്നു.

The multi-volume programmer's manual to a 1975 operating system called CB UNIX

ഈ രംഗത്ത് വിദ്യാഭ്യാസം നേടിയ പ്രൊഫഷണലുകളെ ഡോക്യുമെന്റലിസ്റ്റുകൾ എന്ന് വിളിക്കുന്നു. ഈ ഫീൽഡ് 1968 ൽ അതിന്റെ പേര് ഇൻഫർമേഷൻ സയൻസ് എന്ന് മാറ്റി, പക്ഷേ ഡോക്യുമെന്റേഷൻ എന്ന പദത്തിന്റെ ചില ഉപയോഗങ്ങൾ ഇപ്പോഴും നിലവിലുണ്ട്, കൂടാതെ ഡോക്യുമെന്റേഷൻ എന്ന പദം പഠനമേഖലയായി വീണ്ടും അവതരിപ്പിക്കാനുള്ള ശ്രമങ്ങൾ നടക്കുന്നു.

ഡോക്യുമെന്റേഷൻ നിർമ്മിക്കുന്നതിനുള്ള തത്ത്വങ്ങൾ

ബന്ധപ്പെട്ട ഐ‌എസ്ഒ മാനദണ്ഡങ്ങൾ‌ പൊതുവായി എളുപ്പത്തിൽ‌ ലഭ്യമല്ലെങ്കിലും, ഈ വിഷയത്തിനായുള്ള മറ്റ് ഉറവിടങ്ങളിൽ‌ നിന്നുള്ള ഒരു ഗൈഡ് ഈ ഉദ്ദേശ്യത്തെ സഹായിക്കുന്നു. ^{[1], [2],}.^[3]ഉപയോഗിച്ച പദങ്ങൾ, നടപടിക്രമങ്ങളുടെ നമ്പറിംഗ്, വാക്യങ്ങളുടെ ദൈർഘ്യം മുതലായവയെക്കുറിച്ച് ഡോക്യുമെന്റ് റൈറ്റിംഗിന്റെ നിരവധി തത്ത്വങ്ങൾ ഡേവിഡ് ബെർ‌ഗെർ നൽകിയിട്ടുണ്ട്.^[4]

മാർഗ്ഗനിർദ്ദേശങ്ങൾ

ഓരോ നിർദ്ദിഷ്ട ഫീൽഡും തരവും കൈകാര്യം ചെയ്യുന്ന വഴികാട്ടികളുടെ ഒരു പട്ടിക ചുവടെ ചേർക്കുന്നു:

• ആരോഗ്യ പരിരക്ഷയിലെ ഡോക്യുമെന്റേഷൻ^[5]
• പ്രബന്ധം എഴുതൽ^[6][7][8]
  കൂടുതൽ വിവരങ്ങൾക്ക്: Dissertation
• അക്കാദമിക് ജേണൽ പ്രസിദ്ധീകരണത്തിനുള്ള പ്രബന്ധങ്ങൾ (i.e., ജേണൽ ഓഫ് ഫുഡ് സയൻസ്,^[9] അനലിറ്റിക്കൽ കെമിസ്ട്രി^[10])

നടപടിക്രമങ്ങളും സാങ്കേതികതകളും

ഡോക്യുമെന്റേഷന്റെ നടപടിക്രമങ്ങൾ ഒരു മേഖലയിൽ നിന്ന് അല്ലെങ്കിൽ ഒരു തരത്തിൽ നിന്ന് മറ്റൊന്നിലേക്ക് വ്യത്യാസപ്പെടുന്നു. പൊതുവേ, ഡോക്യുമെന്റ് ഡ്രാഫ്റ്റിംഗ്, ഫോർമാറ്റിംഗ്, സമർപ്പിക്കൽ, അവലോകനം, അംഗീകാരം, വിതരണം, റീപോസ്റ്റിംഗ്, ട്രാക്കിംഗ് തുടങ്ങിയവ ഇതിൽ ഉൾപ്പെടാം. കൂടാതെ ഒരു കാര്യനിർവ്വഹണ ഉദ്യമത്തിലെ ബന്ധപ്പെട്ട സ്റ്റാൻഡേർഡ് ഓപ്പറേറ്റിങ് നടപടിക്രമം (SOPs) ഒന്നിച്ചുകൂട്ടുന്നു. തിരുത്തൽ നടത്തിയ ഉള്ളടക്കം സൃഷ്ടിക്കുന്നതും ഇതിൽ ഉൾപ്പെടാം. ഡോക്യുമെന്റേഷൻ വായിക്കാനും മനസ്സിലാക്കാനും എളുപ്പമായിരിക്കണം. ഇത് ദൈർഘ്യമേറിയതും വളരെ മോശമായതുമാണെങ്കിൽ, അത് തെറ്റിദ്ധരിക്കപ്പെടുകയോ അവഗണിക്കുകയോ ചെയ്യാം. വ്യക്തവും ഹ്രസ്വവും പരിചിതവുമായ വാക്കുകൾ ഒരു വാക്യത്തിലേക്ക് പരമാവധി 15 വാക്കുകൾ വരെ ഉപയോഗിക്കണം. ലിംഗ ഹൈപ്പർ ന്യൂട്രൽ പദം മാത്രം ഉപയോഗിക്കുകയും സാംസ്കാരിക പക്ഷപാതം ഒഴിവാക്കുകയും വേണം. അവ നടപ്പാക്കുമ്പോൾ നടപടിക്രമങ്ങൾ അക്കമിട്ട് നിലനിർത്തണം.^{[11], [12], [13],}.^[14]

ഡോക്യുമെന്റേഷൻ നിർമ്മിക്കുന്നു

സാങ്കേതിക എഴുത്തുകാരും കോർപ്പറേറ്റ് ആശയവിനിമയക്കാരും പ്രൊഫഷണലുകളാണ്, അവരുടെ പ്രവർത്തനമേഖലയും ജോലിയും ഡോക്യുമെന്റേഷൻ നിർമ്മാണമാണ്. സാങ്കേതിക എഴുത്തുകാർക്ക് വിഷയത്തിലും ഉള്ളടക്കമെഴുതുന്നതിലും കൈകാര്യം ചെയ്യുന്നതിലും ഒരു പശ്ചാത്തലമുണ്ട് (ഇൻഫർമേഷൻ ആർക്കിടെക്ചർ). സാങ്കേതിക എഴുത്തുകാർ സാധാരണയായി എഞ്ചിനീയർമാർ, സാങ്കേതിക വിദഗ്ദ്ധർ, മെഡിക്കൽ പ്രൊഫഷണലുകൾ, അല്ലെങ്കിൽ മറ്റ് തരത്തിലുള്ള ഉപഭോക്താക്കൾ എന്നിവരെ പോലുള്ള വിഷയവിദഗ്ദ്ധരുമായി (എസ്എംഇ) സഹകരിക്കുകയും ഉപയോക്താവിന്റെ ആവശ്യങ്ങൾ നിറവേറ്റുന്ന ഉള്ളടക്കം (ഡോക്യുമെന്റേഷൻ) നിർവചിക്കുകയും സൃഷ്ടിക്കുകയും ചെയ്യുന്നു. സംഘടിതമായ അല്ലെങ്കിൽ ഏകീകൃതമായ ആശയവിനിമയങ്ങളിൽ മിക്ക കമ്പനികൾക്കും ആവശ്യമായ മറ്റ് തരത്തിലുള്ള രേഖാമൂലമുള്ള ഡോക്യുമെന്റേഷൻ കാണപ്പെടുന്നു.

പ്രത്യേക ഡോക്യുമെന്റേഷൻ

• മാർക്കറ്റിംഗ് കമ്മ്യൂണിക്കേഷൻസ് (MarCom): വിവിധതരം അച്ചടി, ഇലക്‌ട്രോണിക്, സോഷ്യൽ മീഡിയകളിലൂടെ കമ്പനിയുടെ മൂല്യനിർണ്ണയം അറിയിക്കാൻ മാർക്കോം എഴുത്തുകാർ ശ്രമിക്കുന്നു. സംഘടിത രചനയുടെ ഈ മേഖല പലപ്പോഴും നിർദ്ദേശങ്ങളോട് പ്രതികരിക്കുന്നതിൽ വ്യാപൃതരാണ്.
• ടെക്നിക്കൽ കമ്മ്യൂണിക്കേഷൻ (TechCom): സാങ്കേതിക എഴുത്തുകാർ ഒരു കമ്പനിയുടെ ഉൽപ്പന്നമോ സേവനമോ രേഖപ്പെടുത്തുന്നു. സാങ്കേതിക പ്രസിദ്ധീകരണത്തിൽ ഉപയോക്തൃ ഗൈഡുകൾ, ഇൻസ്റ്റാളേഷൻ, കോൺഫിഗറേഷൻ മാനുവലുകൾ, ട്രബിൾഷൂട്ടിംഗ് / റിപ്പയർ / മാറ്റിസ്ഥാപിക്കൽ നടപടിക്രമങ്ങൾ എന്നിവ ഉൾപ്പെടുന്നു..
• നിയമപരമായ എഴുത്ത്: സ്വകാര്യ പ്രാക്ടീസിൽ ഏർപ്പെടാവുന്ന അല്ലെങ്കിൽ കോർപ്പറേറ്റ് കൗൺസിലായി നിലനിർത്താൻ കഴിയുന്ന അഭിഭാഷകരോ പാരലീഗലുകളോ ആണ് ഇത്തരം ഡോക്യുമെന്റേഷൻ പലപ്പോഴും തയ്യാറാക്കുന്നത്.
• ആജ്ഞാനുവർത്തിത്വം ഡോക്യുമെന്റേഷൻ : സുരക്ഷാ അംഗീകാരം, നികുതി ഏർപ്പെടുത്തൽ, ധനസഹായം, സാങ്കേതിക അംഗീകാരം മുതലായവ പോലുള്ള ഏതെങ്കിലും കാര്യനിർവ്വഹണ ആജ്ഞാനുവർത്തിത്വ ആവശ്യങ്ങൾക്കായി ഈ തരത്തിലുള്ള ഡോക്യുമെന്റേഷനുവേണ്ടി സ്റ്റാൻഡേർഡ് ഓപ്പറേറ്റിംഗ് നടപടിക്രമങ്ങൾ (എസ്ഒപി) ക്രമീകരിക്കുന്നു.

ഇൻഡെക്സിംഗ്

• Index (database)
• Index (search engine)

കമ്പ്യൂട്ടർ സയൻസിലെ ഡോക്യുമെന്റേഷൻ

പ്രധാന ലേഖനം: സോഫ്റ്റ്‌വെയർ ഡോക്യുമെന്റേഷൻ

ഇനിപ്പറയുന്നവ സാധാരണ സോഫ്റ്റ്‌വേർ ഡോക്യുമെന്റേഷൻ തരങ്ങളാണ്

• നിർദ്ദേശത്തിനുള്ള അഭ്യർത്ഥന (RFP)
• ആവശ്യകതകൾ / ജോലിയുടെ പ്രസ്താവന / ജോലിയുടെ ലക്ഷ്യം (SOW)
• സോഫ്റ്റ്‌വേർ ഡിസൈനും ഫംഗ്ഷണൽ സ്പെസിഫിക്കേഷനും
• സിസ്റ്റം രൂപകൽപ്പനയും പ്രവർത്തന സവിശേഷതകളും
• മാനേജ്മെന്റിന്റെ മാറ്റങ്ങൾ, എറർ ആന്റ് എൻഹാൻസ്മെന്റ് ട്രാക്കിംഗ്
• ഉപയോക്തൃ സ്വീകാര്യത പരിശോധന
• മാൻപേജെസ്
• പേൾഡോക്സ്

സാധാരണ ഹാർഡ്‌വെയർ, സേവന ഡോക്യുമെന്റേഷൻ തരങ്ങൾ ഇനിപ്പറയുന്നവയാണ്.

• നെറ്റ്‌വർക്ക് ഡയഗ്രമുകൾ
• നെറ്റ്‌വർക്ക് ചിത്രങ്ങൾ
• ഐടി സിസ്റ്റങ്ങൾക്കായുള്ള ഡാറ്റാഷീറ്റ് (സെർവർ, സ്വിച്ച്, ഉദാ.)
• സേവന കാറ്റലോഗും സേവന പോർട്ട്‌ഫോളിയോയും (ITIL)

ഡോക്യുമെന്റേഷനിൽ സാധ്യതാ റിപ്പോർട്ട്, സാങ്കേതിക ഡോക്യുമെന്റേഷൻ, പ്രവർത്തന ഡോക്യുമെന്റേഷൻ, ലോഗ് ബുക്ക് മുതലായവ ഉൾപ്പെടുന്നു.

സോഫ്റ്റ്‌വേർ ഡോക്യുമെന്റ് ചെയ്യുന്നതിനുള്ള ഉപകരണങ്ങൾ

ഡോക്യുമെന്റേഷൻ സൃഷ്ടിക്കാൻ നിരവധി തരം സോഫ്റ്റ്വെയറുകളും ആപ്ലിക്കേഷനുകളും ഉപയോഗിക്കുന്നു.

സോഫ്റ്റ്‌വേർ ഡോക്യുമെന്റേഷൻ ഫോൾഡർ (എസ്ഡിഎഫ്)

സിമുലേഷൻ വ്യവസായത്തിലെ സോഫ്റ്റ്‌വേർ എഞ്ചിനീയർമാർ എഴുതിയ ഒരു സാധാരണ തരം സോഫ്റ്റ്‌വേർ പ്രമാണം എസ്ഡിഎഫ് ആണ്. ഒരു സിമുലേറ്ററിനായി സോഫ്റ്റ്‌വേർ വികസിപ്പിക്കുമ്പോൾ, പൂർണ്ണ ചലന നിയന്ത്രണ സംവിധാനങ്ങളുള്ള ഏവിയോണിക്സ് ഉപകരണങ്ങൾ മുതൽ 3 ഡി ടെറൈൻ ഡാറ്റാബേസുകൾ വരെയുള്ള എഞ്ചിനീയർ പ്രോജക്റ്റിന്റെയോ മൊഡ്യൂളിന്റെയോ വികസനം വിശദീകരിക്കുന്ന ഒരു നോട്ട്ബുക്ക് സൂക്ഷിക്കുന്നു. പ്രമാണം ഒരു വിക്കി പേജ്, എം‌എസ് വേഡ് ഡോക്യുമെന്റ് അല്ലെങ്കിൽ മറ്റ് പരിസ്ഥിതിയും ആകാം. സോഫ്റ്റ്‌വെയറിന്റെ ആശയവിനിമയ ഇന്റർഫേസ് വിശദീകരിക്കുന്ന ഒരു ഇന്റർഫേസ് വിഭാഗത്തിന്റെ ആവശ്യകതകൾ അവയിൽ അടങ്ങിയിരിക്കണം. ആശയത്തിന്റെ തെളിവ് വിശദീകരിക്കുന്നതിന് പലപ്പോഴും ഒരു കുറിപ്പുകൾ വിഭാഗം ഉപയോഗിക്കുന്നു. തുടർന്ന് പിശകുകളും മെച്ചപ്പെടുത്തലുകളും അടയാളപ്പെടുത്തുന്നു. അവസാനമായി, സോഫ്റ്റ്‌വേർ എങ്ങനെ പരീക്ഷിച്ചുവെന്ന് രേഖപ്പെടുത്തുന്നതിനുള്ള ഒരു പരിശോധന വിഭാഗവും ഉൾപ്പെടുന്നു. ഇത് ക്ലയന്റിന്റെ ആവശ്യകതകളുമായി പൊരുത്തപ്പെടുന്നു. സോഫ്റ്റ്‌വേർ എങ്ങനെ രൂപകൽപ്പന ചെയ്യാം, ഉദ്ദിഷ്‌ടഫലത്തിനുവേണ്ടിയുള്ള പ്രയോഗതന്ത്രം സോഫ്റ്റ്‌വേർ എങ്ങനെ നിർമ്മിക്കാം, എങ്ങനെ ഇൻസ്റ്റാൾ ചെയ്യാം, അറിയപ്പെടുന്ന ഏതെങ്കിലും തകരാറുകൾ, ജോലിസ്ഥലങ്ങൾ എന്നിവയുടെ വിശദമായ വിവരണമാണ് ഫലം. ഈ പ്രമാണ നിർമ്മാണം ഭാവിയിലെ കമ്പ്യൂട്ടർ പ്രോഗ്രാമുകൾ വികസിപ്പിക്കുന്നരെയും പരിപാലകരെയും സമയബന്ധിതമായി സോഫ്റ്റ്‌വേർ വേഗത്തിലാക്കാൻ പ്രാപ്‌തമാക്കുന്നു. കൂടാതെ കോഡ് പരിഷ്‌ക്കരിക്കുന്നതിനോ ബഗുകൾക്കായി തിരയുന്നതിനോ ഒരു റോഡ്മാപ്പ് നൽകുന്നു.

നെറ്റ്വർക്ക് ഇൻവെന്ററി, കോൺഫിഗറേഷൻ (സിഎംഡിബി) എന്നിവയ്ക്കുള്ള സോഫ്റ്റ്‌വേർ

ഈ സോഫ്റ്റ്‌വേർ ഉപകരണങ്ങൾക്ക് നിങ്ങളുടെ നെറ്റ്‌വർക്ക് ഉപകരണങ്ങളുടെ ഡാറ്റ സ്വപ്രേരിതമായി ശേഖരിക്കാൻ കഴിയും. ഡാറ്റ ഇൻവെന്ററി, കോൺഫിഗറേഷൻ വിവരങ്ങൾ എന്നിവയായിരിക്കാം. ഐടി ഉത്തരവാദിത്തമുള്ള എല്ലാ വിവരങ്ങൾക്കും അടിസ്ഥാനമായി അത്തരമൊരു ഡാറ്റാബേസ് സൃഷ്ടിക്കാൻ ഐടിഐഎൽ ലൈബ്രറി അഭ്യർത്ഥിക്കുന്നു. ഐടി ഡോക്യുമെന്റേഷന്റെ അടിസ്ഥാനം കൂടിയാണിത്. XIA കോൺഫിഗറേഷൻ ഉദാഹരണങ്ങളിൽ ഉൾപ്പെടുന്നു.^[15].

ക്രിമിനൽ നിയമത്തിലെ ഡോക്യുമെന്റേഷൻ

ക്രിമിനൽ ഡാറ്റാബേസുകൾ ജനകീയമാക്കുന്നതിനുള്ള പ്രക്രിയയാണ് "ഡോക്യുമെന്റേഷൻ". നാഷണൽ കൗണ്ടർ-ടെററിസം സെന്ററിന്റെ ടെററിസ്റ്റ് ഐഡന്റിറ്റീസ് ഡാറ്റമാർട്ട് എൻവയോൺമെന്റ് ("ടൈഡ്") ("TIDE"), ലൈംഗിക കുറ്റവാളികളുടെ രജിസ്ട്രികൾ, സംഘ ഡാറ്റാബേസുകൾ എന്നിവ ഉദാഹരണം.^[16]

ആദ്യകാല ബാല്യകാല വിദ്യാഭ്യാസത്തിലെ ഡോക്യുമെന്റേഷൻ

"ലോകത്തെക്കുറിച്ചുള്ള കുട്ടികളുടെ ആശയങ്ങൾ, ചിന്തകൾ, ചോദ്യങ്ങൾ, സിദ്ധാന്തങ്ങൾ എന്നിവ ശ്രദ്ധിക്കുകയും വിലമതിക്കുകയും തുടർന്ന് വിശാലമായ ഒരു കമ്മ്യൂണിറ്റിയുമായി പങ്കിടുന്നതിന് അവരുടെ പ്രവർത്തനങ്ങൾ (ഡ്രോയിംഗുകൾ, കുട്ടികളുടെ ഫോട്ടോകൾ, അവരുടെ പ്രവർത്തനങ്ങളുടെ പകർപ്പുകൾ) ശേഖരിക്കുകയും ചെയ്യുന്നതാണ്" ആദ്യകാല ബാല്യകാല വിദ്യാഭ്യാസ മേഖലയുമായി ബന്ധപ്പെട്ട ഡോക്യുമെന്റേഷൻ.^[17]

ഇതും കാണുക

• Authoring
• Bibliographic control
• Change control
• Citation Index
• Copyright
• Description
• Document
• Documentation (field)
• Documentation science
• Document identifier
• Document management system
• Documentary
• Freedom of information
• Glossary
• Historical document
• Index (publishing)
• ISO 2384:1977
• ISO 259:1984
• ISO 5123:1984
• ISO 3602:1989
• ISO 6357:1985
• ISO 690
• ISO 5964
• ISO 9001
• IEC 61355
• International Standard Bibliographic Description
• Journal of Documentation
• Licensing
• Letterhead
• List of Contents
• Technical documentation
• User guide
• Medical certificate
• Publishing
• Records management
• Software documentation
• Style guide
• Technical communication