రచయిత:
Roger Morrison
సృష్టి తేదీ:
3 సెప్టెంబర్ 2021
నవీకరణ తేదీ:
6 మే 2024
విషయము
మంచి సాఫ్ట్‌వేర్ డాక్యుమెంటేషన్ - ప్రోగ్రామర్‌లు మరియు పరీక్షకుల కోసం, అంతర్గత వినియోగదారుల కోసం సాంకేతిక పత్రాల కోసం లేదా సాఫ్ట్‌వేర్ మాన్యువల్‌ల కోసం మరియు తుది వినియోగదారుల కోసం ఫైళ్ళకు సహాయపడండి - సాఫ్ట్‌వేర్‌తో పనిచేసే వ్యక్తికి దాని విధులు మరియు లక్షణాలను అర్థం చేసుకోవడానికి సహాయపడుతుంది. మంచి డాక్యుమెంటేషన్ నిర్దిష్ట, సంక్షిప్త మరియు సంబంధితమైనది, ప్రోగ్రామ్‌ను ఉపయోగించే ప్రజలకు అన్ని ముఖ్యమైన సమాచారాన్ని అందిస్తుంది. సాంకేతిక మరియు తుది వినియోగదారుల కోసం సాఫ్ట్‌వేర్ డాక్యుమెంటేషన్ రాయడానికి సూచనల కోసం చదవండి.
స్టెప్స్
2 యొక్క విధానం 1: సాంకేతిక వినియోగదారుల కోసం సాఫ్ట్‌వేర్ డాక్యుమెంటేషన్ రాయడం
ఏ సమాచారాన్ని చేర్చాలో నిర్ణయించండి. సాఫ్ట్‌వేర్ స్పెసిఫికేషన్ పత్రాలు వినియోగదారు ఇంటర్ఫేస్ డిజైనర్లు, కోడ్ వ్రాసే ప్రోగ్రామర్‌లు మరియు సాఫ్ట్‌వేర్ కావలసిన విధంగా పనిచేస్తుందని ధృవీకరించే పరీక్షకులకు రిఫరెన్స్ మాన్యువల్‌గా పనిచేస్తాయి. ఖచ్చితమైన సమాచారం సందేహాస్పద ప్రోగ్రామ్‌పై ఆధారపడి ఉంటుంది, కానీ వీటిని కలిగి ఉండవచ్చు:
- అనువర్తనంలోని కీ ఫైల్‌లు. అభివృద్ధి బృందం సృష్టించిన ఫైల్‌లు, ప్రోగ్రామ్ ఆపరేషన్ సమయంలో యాక్సెస్ చేసిన డేటాబేస్‌లు మరియు మూడవ పార్టీ యుటిలిటీలను అవి కలిగి ఉంటాయి.
- విధులు మరియు సబ్ట్రౌటిన్లు. ప్రతి ఫంక్షన్ లేదా సబ్‌ట్రౌటిన్ దాని ఇన్పుట్ మరియు అవుట్పుట్ విలువలతో సహా ఏమి చేస్తుందో ఇక్కడ ఒక వివరణ చేర్చబడింది.
- ప్రోగ్రామ్ వేరియబుల్స్ మరియు స్థిరాంకాలు మరియు అవి అప్లికేషన్‌లో ఎలా ఉపయోగించబడతాయి.
- కార్యక్రమం యొక్క సాధారణ నిర్మాణం. డిస్క్-ఆధారిత అనువర్తనం కోసం, ఇది ప్రోగ్రామ్ యొక్క వ్యక్తిగత మాడ్యూల్స్ మరియు లైబ్రరీలను వివరించడం అని అర్ధం, వెబ్ అప్లికేషన్ కోసం, ఏ పేజీలు ఏ ఫైళ్ళను ఉపయోగిస్తాయో దాని యొక్క వివరణ.
ప్రోగ్రామ్ కోడ్‌లో డాక్యుమెంటేషన్ ఎంత ఉండాలి మరియు దాని నుండి ఎంత వేరు చేయాలో నిర్ణయించండి. ప్రోగ్రామ్ సోర్స్‌లో మరింత సాంకేతిక డాక్యుమెంటేషన్ అభివృద్ధి చేయబడితే, కోడ్‌ను నవీకరించడం మరియు నిర్వహించడం సులభం, అలాగే అసలు అప్లికేషన్ యొక్క వివిధ వెర్షన్లను డాక్యుమెంట్ చేస్తుంది. కనిష్టంగా, సోర్స్ కోడ్‌లోని డాక్యుమెంటేషన్ ఫంక్షన్లు, సబ్ట్రౌటిన్లు, వేరియబుల్స్ మరియు స్థిరాంకాల ప్రయోజనాన్ని వివరించాలి.- సోర్స్ కోడ్ ముఖ్యంగా పొడవుగా ఉంటే, దాన్ని సహాయ ఫైలు రూపంలో డాక్యుమెంట్ చేయవచ్చు, ఇది ఇండెక్స్ చేయవచ్చు లేదా కీలకపదాలతో శోధించవచ్చు. ప్రోగ్రామ్ లాజిక్ చాలా పేజీలలో విచ్ఛిన్నమై, అనేక అనుబంధ ఫైళ్ళతో పాటు కొన్ని వెబ్ అనువర్తనాలతో కూడిన అనువర్తనాలకు ఇది ఒక ప్రత్యేక ప్రయోజనం.
- జావా మరియు .NET ఫ్రేమ్‌వర్క్ (విజువల్ బేసిక్. నెట్, సి #) వంటి కొన్ని ప్రోగ్రామింగ్ భాషలు కోడ్‌ను డాక్యుమెంట్ చేయడానికి వారి స్వంత ప్రోగ్రామ్‌లను కలిగి ఉన్నాయి. అటువంటి సందర్భాలలో, చేర్చవలసిన డాక్యుమెంటేషన్ మొత్తానికి ప్రమాణాలను అనుసరించండి.
సరైన డాక్యుమెంటేషన్ సాధనాన్ని ఎంచుకోండి. కొంతవరకు, ఈ మరియు ఇతర భాషలకు నిర్దిష్ట సాధనాలు ఉన్నందున, C ++, C #, విజువల్ బేసిక్, జావా లేదా PHP లలో కోడ్ వ్రాయబడిన భాష ద్వారా ఇది నిర్ణయించబడుతుంది. ఇతర సందర్భాల్లో, ఉపయోగించాల్సిన సాధనం అవసరమైన డాక్యుమెంటేషన్ రకాన్ని బట్టి నిర్ణయించబడుతుంది.- డాక్యుమెంటేషన్ సాపేక్షంగా చిన్నది మరియు సరళంగా ఉన్నంతవరకు మైక్రోసాఫ్ట్ వర్డ్ కోసం వర్డ్ ప్రాసెసింగ్ ప్రోగ్రామ్‌లు ప్రత్యేక టెక్స్ట్ ఫైల్‌లను రూపొందించడానికి అనుకూలంగా ఉంటాయి. దీర్ఘ మరియు సంక్లిష్టమైన టెక్స్ట్ ఫైళ్ళ కోసం, చాలా మంది సాంకేతిక రచయితలు అడోబ్ ఫ్రేమ్‌మేకర్ వంటి డాక్యుమెంటేషన్ సాధనాన్ని ఇష్టపడతారు.
- సోర్స్ కోడ్‌ను డాక్యుమెంట్ చేయడానికి సహాయ ఫైళ్ళను సాంకేతిక రచన కోసం రోబోహెల్ప్, హెల్ప్ అండ్ మాన్యువల్, డాక్-టు-హెల్ప్, మ్యాడ్‌క్యాప్ ఫ్లేర్ లేదా హెల్ప్‌లాగిక్స్ వంటి ఏదైనా సహాయ సాధనంతో ఉత్పత్తి చేయవచ్చు.
2 యొక్క విధానం 2: తుది వినియోగదారుల కోసం సాఫ్ట్‌వేర్ డాక్యుమెంటేషన్ రాయడం
డాక్యుమెంటేషన్ యొక్క వ్యాపార ప్రయోజనాలను నిర్ణయించండి. అనువర్తనాన్ని ఎలా ఉపయోగించాలో అర్థం చేసుకోవడంలో వినియోగదారులకు సహాయపడటమే క్రియాత్మక కారణం అయినప్పటికీ, ప్రోగ్రామ్‌ను ప్రకటించడంలో సహాయపడటం, సంస్థ యొక్క ఇమేజ్‌ను మెరుగుపరచడం మరియు ముఖ్యంగా సాంకేతిక మద్దతు ఖర్చులను తగ్గించడం వంటి ఇతర కారణాలు కూడా ఉన్నాయి. కొన్ని సందర్భాల్లో, కొన్ని నిబంధనలు లేదా ఇతర చట్టపరమైన అవసరాలకు అనుగుణంగా డాక్యుమెంటేషన్ అవసరం.- ఏ పరిస్థితులలోనైనా, డాక్యుమెంటేషన్ చెడ్డ ఇంటర్ఫేస్ డిజైన్‌ను భర్తీ చేయకూడదు. ఒక అప్లికేషన్ స్క్రీన్‌కు దాన్ని వివరించడానికి పేజీలు మరియు డాక్యుమెంటేషన్ పేజీలు అవసరమైతే, డిజైన్‌ను మరింత సహజంగా మార్చడానికి మార్చడం మంచిది.
మీరు డాక్యుమెంటేషన్ వ్రాస్తున్న ప్రేక్షకులను అర్థం చేసుకోండి. చాలా సందర్భాల్లో, సాఫ్ట్‌వేర్ వినియోగదారులకు వారు ఉపయోగించే అనువర్తనాల పనులకు మించి కంప్యూటర్ల గురించి తక్కువ అవగాహన ఉంటుంది. మీ డాక్యుమెంటేషన్‌తో మీ అవసరాలను ఎలా తీర్చాలో నిర్ణయించడానికి అనేక మార్గాలు ఉన్నాయి.
- సంభావ్య వినియోగదారుల ఉద్యోగ పేర్లను గమనించండి. సిస్టమ్ అడ్మినిస్ట్రేటర్ వివిధ రకాల సాఫ్ట్‌వేర్ అనువర్తనాల్లో ప్రవీణుడు కావచ్చు, అయితే డేటా ఎంట్రీ వర్కర్ డేటాను నమోదు చేయడానికి అతను ఉపయోగించే అప్లికేషన్‌ను మాత్రమే తెలుసుకునే అవకాశం ఉంది.
- వినియోగదారులను వారే గమనించండి. ఉద్యోగుల శీర్షికలు తరచుగా ప్రజలు ఏమి చేస్తున్నాయో సూచిస్తుండగా, ఇచ్చిన సంస్థలో కొన్ని శీర్షికలు ఎలా ఉపయోగించబడుతున్నాయనే దానిపై గణనీయమైన వైవిధ్యం ఉంటుంది. సంభావ్య వినియోగదారులను ఇంటర్వ్యూ చేయడం ద్వారా, మీ అవసరాలకు సంబంధించిన మీ ముద్రలు ఖచ్చితమైనవి కాదా అని మీరు తెలుసుకోవచ్చు.
- ఇప్పటికే ఉన్న డాక్యుమెంటేషన్ గమనించండి. సాఫ్ట్‌వేర్ యొక్క మునుపటి సంస్కరణల యొక్క డాక్యుమెంటేషన్, అలాగే ఫంక్షనల్ స్పెసిఫికేషన్‌లు, ప్రోగ్రామ్‌ను ఉపయోగించడానికి వినియోగదారు తెలుసుకోవలసిన వాటికి కొన్ని సూచనలు ఇస్తాయి. అయితే, తుది వినియోగదారులు ప్రోగ్రామ్ ఎలా పనిచేస్తుందనే దానిపై ఆసక్తి చూపడం లేదని గుర్తుంచుకోండి, కానీ అది వారికి ఏమి చేయగలదో.
- పనిని పూర్తి చేయడానికి అవసరమైన పనులను మరియు వాటి ముందు చేయవలసిన పనులను గుర్తించండి.
డాక్యుమెంటేషన్ కోసం తగిన ఫార్మాట్లను నిర్ణయించండి. సాఫ్ట్‌వేర్ డాక్యుమెంటేషన్‌ను 1 లేదా 2 ఫార్మాట్లలో, రిఫరెన్స్ మాన్యువల్ మరియు యూజర్ గైడ్‌లో నిర్మించవచ్చు. కొన్నిసార్లు ఫార్మాట్ల కలయిక ఉత్తమ విధానం.
- అనువర్తనం యొక్క వ్యక్తిగత లక్షణాలను (బటన్లు, ట్యాబ్‌లు, ఫీల్డ్‌లు మరియు డైలాగ్‌లు) మరియు అవి ఎలా పని చేస్తాయో వివరించడానికి రిఫరెన్స్ మాన్యువల్ ఫార్మాట్ అంకితం చేయబడింది. చాలా సహాయ ఫైళ్లు ఈ ఫార్మాట్‌లో వ్రాయబడ్డాయి, ఇది ఒక నిర్దిష్ట స్క్రీన్‌పై వినియోగదారు సహాయ బటన్‌ను క్లిక్ చేసినప్పుడు సంబంధిత అంశాన్ని ప్రదర్శిస్తుంది.
- ఒక నిర్దిష్ట పనిని నిర్వహించడానికి ప్రోగ్రామ్‌ను ఎలా ఉపయోగించాలో యూజర్ గైడ్ ఫార్మాట్ వివరిస్తుంది. ఈ మార్గదర్శకాలు సాధారణంగా PDF లలో ముద్రించబడతాయి లేదా ప్రదర్శించబడతాయి, అయినప్పటికీ కొన్ని సహాయ ఫైళ్ళలో నిర్దిష్ట పనులను ఎలా చేయాలనే దానిపై విషయాలు ఉంటాయి (ఈ సహాయ విషయాలు సాధారణంగా సందర్భోచితంగా ఉండవు, అయినప్పటికీ అవి అంశాలకు లింక్‌లను కలిగి ఉండవచ్చు). వాడుకరి గైడ్‌లు సాధారణంగా ట్యుటోరియల్‌ల రూపాన్ని తీసుకుంటారు, పరిచయంలో చేయవలసిన పనుల సారాంశం మరియు సంఖ్యా దశల్లో ఇచ్చిన సూచనలు.
డాక్యుమెంటేషన్ ఏ రూపాలను తీసుకోవాలో నిర్ణయించండి. తుది వినియోగదారుల కోసం సాఫ్ట్‌వేర్ డాక్యుమెంటేషన్ అనేక లేదా అనేక రూపాల్లో ఒకటి తీసుకోవచ్చు: ముద్రిత మాన్యువల్లు, పిడిఎఫ్ పత్రాలు, సహాయ ఫైళ్లు లేదా ఆన్‌లైన్ సహాయం. ప్రతి ఫారమ్ వాక్‌త్రూ లేదా ట్యుటోరియల్ రూపంలో అయినా ప్రోగ్రామ్ యొక్క ప్రతి ఫంక్షన్‌ను ఎలా ఉపయోగించాలో వినియోగదారుకు చూపించడానికి రూపొందించబడింది; సహాయ ఫైళ్లు మరియు ఆన్‌లైన్ సహాయం విషయంలో, మీరు డెమో వీడియోలు, అలాగే టెక్స్ట్ మరియు చిత్రాలను చేర్చవచ్చు.
- సహాయ ఫైళ్లు తప్పనిసరిగా ఇండెక్స్ చేయబడతాయి మరియు కీలకపదాల ద్వారా శోధించబడతాయి, తద్వారా వినియోగదారులు వారు కోరుకున్న సమాచారాన్ని త్వరగా కనుగొనగలరు. వ్రాసే సాధనాలు స్వయంచాలకంగా సూచికలను ఉత్పత్తి చేయగలిగినప్పటికీ, వినియోగదారులు శోధించే పదాలను ఉపయోగించి దీన్ని మాన్యువల్‌గా చేయడం మంచిది.
తగిన డాక్యుమెంటేషన్ సాధనాన్ని ఎంచుకోండి. ప్రింటెడ్ లేదా పిడిఎఫ్ మాన్యువల్‌లను వాటి పరిమాణం మరియు సంక్లిష్టతను బట్టి వర్డ్ వంటి వర్డ్ ప్రాసెసింగ్ ప్రోగ్రామ్ లేదా ఫ్రేమ్‌మేకర్ వంటి అధునాతన టెక్స్ట్ ఎడిటర్‌తో వ్రాయవచ్చు. సహాయ ఫైళ్ళను రోబోహెల్ప్, హెల్ప్ అండ్ మాన్యువల్, డాక్-టు-హెల్ప్, ఫ్లేర్, హెల్ప్‌లాగిక్స్ లేదా హెల్ప్‌సర్వర్ వంటి నిర్దిష్ట ఫైల్‌తో వ్రాయవచ్చు.
చిట్కాలు
- వచనాన్ని సులువుగా చదవడానికి, వాటికి సంబంధించిన వచనానికి దగ్గరగా చిత్రాలను ఉంచాలి. తార్కికంగా డాక్యుమెంటేషన్‌ను విభాగాలు మరియు అంశాలుగా విభజించండి. ప్రతి విభాగం లేదా అంశాన్ని అవసరమైన విధంగా "కూడా చూడండి" లేదా లింక్‌లతో సూచించవచ్చు.
- డాక్యుమెంటేషన్‌కు బహుళ స్క్రీన్‌షాట్‌లు అవసరమైతే పైన జాబితా చేసిన డాక్యుమెంటేషన్ సాధనాలను స్నాగిట్ వంటి స్క్రీన్షాట్ సృష్టి ప్రోగ్రామ్‌తో భర్తీ చేయవచ్చు. ఇతర డాక్యుమెంటేషన్ మాదిరిగా, ఈ స్క్రీన్షాట్లను ప్రోగ్రామ్ ఎలా పనిచేస్తుందో వివరించడానికి సహాయపడుతుంది, వినియోగదారుని ఆకట్టుకోకుండా.
- స్వరం ముఖ్యంగా ముఖ్యం, ముఖ్యంగా తుది వినియోగదారుల కోసం డాక్యుమెంటేషన్ రాసేటప్పుడు. "వినియోగదారులు" కు బదులుగా వారిని "మీరు" అని పిలవండి.
అవసరమైన పదార్థాలు
- సాఫ్ట్‌వేర్ డాక్యుమెంటేషన్ సాధనం / సహాయ ఫైళ్లు
- స్క్రీన్షాట్ సృష్టి సాధనం
