ጥሩ የሶፍትዌር ሰነድ ፣ ለፕሮግራም አዘጋጆች እና ለሞካሪዎች ዝርዝር መግለጫ ሰነድ ፣ ለውስጣዊ ተጠቃሚዎች ቴክኒካዊ ሰነዶች ፣ ወይም ማኑዋሎች እና ለዋና ተጠቃሚዎች የእገዛ ፋይሎች ፣ ተጠቃሚዎች የሶፍትዌሩን ባህሪዎች እና ተግባራት እንዲረዱ ይረዳቸዋል። ጥሩ ሰነድ ተጠቃሚው በሚፈልገው መረጃ ሁሉ የተወሰነ ፣ ግልፅ እና ተዛማጅ የሆነ ሰነድ ነው። ይህ ጽሑፍ ለቴክኒካዊ ተጠቃሚዎች እና ለዋና ተጠቃሚዎች የሶፍትዌር ሰነዶችን እንዲጽፉ ይመራዎታል።
ደረጃ
ዘዴ 1 ከ 2: ለቴክኒካዊ ተጠቃሚዎች የሶፍትዌር ሰነድ መጻፍ
ደረጃ 1. ምን መረጃ ማካተት እንዳለበት ይወቁ።
የዝርዝሩ ሰነድ እንደ በይነገጽ ዲዛይነሮች ፣ ኮድ ለሚጽፉ ፕሮግራም አድራጊዎች እና የሶፍትዌር አፈፃፀምን የሚያረጋግጡ ሞካሪዎች እንደ ማጣቀሻ መመሪያ ሆኖ ያገለግላል። ማካተት ያለበት መረጃ በተፈጠረው ፕሮግራም ላይ የሚመረኮዝ ይሆናል ፣ ግን የሚከተሉትን ሊያካትት ይችላል-
- በመተግበሪያው ውስጥ ያሉ አስፈላጊ ፋይሎች ፣ በልማት ቡድኑ የተፈጠሩ ፋይሎች ፣ ፕሮግራሙ በሚሠራበት ጊዜ የተደረሱ የውሂብ ጎታዎች እና የሶስተኛ ወገን መተግበሪያዎች።
- የተግባሩ/ንዑስ ክፍል ፣ የግብዓት እና የውጤት እሴቶችን አጠቃቀም ማብራሪያን ጨምሮ ተግባራት እና ንዑስ ቡድኖች።
- የፕሮግራም ተለዋዋጮች እና ቋሚዎች ፣ እና እንዴት ጥቅም ላይ እንደሚውሉ።
- አጠቃላይ የፕሮግራም አወቃቀር። በመንዳት ላይ ለተመሰረቱ ፕሮግራሞች ፣ እያንዳንዱን ሞዱል እና ቤተ-መጽሐፍት መግለፅ ያስፈልግዎታል። ወይም ፣ ለድር-ተኮር ፕሮግራም ማኑዋል የሚጽፉ ከሆነ ፣ እያንዳንዱ ገጽ የትኞቹን ፋይሎች እንደሚጠቀም ማስረዳት ያስፈልግዎታል።
ደረጃ 2. የሰነዶች ደረጃ ምን መሆን እንዳለበት እና ከፕሮግራሙ ኮድ ሊለይ የሚችል መሆኑን ይወስኑ።
በፕሮግራሙ ኮድ ውስጥ የተካተተው ብዙ ቴክኒካዊ ሰነዶች እሱን ለማዘመን እና ለማቆየት እንዲሁም የተለያዩ የፕሮግራሙን ስሪቶች ለማብራራት ቀላል ይሆናል። ቢያንስ በፕሮግራሙ ኮድ ውስጥ ያሉት ሰነዶች ተግባሮችን ፣ ንዑስ ቡድኖችን ፣ ተለዋዋጮችን እና ቋሚዎችን አጠቃቀም ማካተት አለባቸው።
- የምንጭ ኮድዎ ረጅም ከሆነ ሰነዶችን በእገዛ ፋይል ውስጥ መጻፍ ይችላሉ ፣ ከዚያ በተወሰኑ ቁልፍ ቃላት ሊጠቁም ወይም ሊፈለግ ይችላል። የፕሮግራሙ አመክንዮ በበርካታ ገጾች ላይ ከተከፈለ እና እንደ የድር ትግበራ ያሉ የድጋፍ ፋይሎችን የሚያካትት ከሆነ የተለየ የሰነድ ፋይሎች ጠቃሚ ናቸው።
- አንዳንድ የፕሮግራም ቋንቋዎች (እንደ ጃቫ ፣ Visual Basic. NET ፣ ወይም C#ያሉ) የራሳቸው የኮድ ሰነድ መመዘኛዎች አሏቸው። በእንደዚህ ዓይነት ሁኔታዎች ውስጥ በምንጩ ኮድ ውስጥ መካተት ያለበትን መደበኛ ሰነዶችን ይከተሉ።
ደረጃ 3. ተገቢውን የሰነድ መሣሪያ ይምረጡ።
በአንዳንድ ሁኔታዎች የሰነድ መሣሪያው የሚወሰነው በተጠቀመበት የፕሮግራም ቋንቋ ነው። ቋንቋዎቹ C ++ ፣ C#፣ Visual Basic ፣ Java ፣ PHP እና ሌሎችም የራሳቸው የሰነድ መሣሪያዎች አሏቸው። ሆኖም ፣ ካልሆነ ፣ ያገለገሉ መሣሪያዎች በሚፈለገው ሰነድ ላይ ይወሰናሉ።
- እንደ ማይክሮሶፍት ዎርድ ያሉ የቃላት ፕሮሰሰር ሰነዱ አጭር እና ቀላል እስከሆነ ድረስ የሰነድ የጽሑፍ ፋይሎችን ለመፍጠር ተስማሚ ነው። ውስብስብ ጽሑፍ ያለው ረጅም ሰነድ ለመፍጠር ፣ አብዛኛዎቹ ቴክኒካዊ ጸሐፊዎች እንደ Adobe FrameMaker ያሉ ልዩ የሰነድ መሣሪያን ይመርጣሉ።
- የምንጭ ኮድን ለመመዝገብ የእገዛ ፋይሎች እንደ RoboHelp ፣ እገዛ እና ማንዋል ፣ ዶክ-ወደ-እገዛ ፣ ማድካፕ ፍላየር ፣ ወይም HelpLogix ባሉ የድጋፍ ፋይል ጄኔሬተር ፕሮግራም ሊፈጥሩ ይችላሉ።
ዘዴ 2 ከ 2 - ለዋና ተጠቃሚዎች የሶፍትዌር ሰነድ መጻፍ
ደረጃ 1. የመመሪያው መፈጠርን መሠረት ያደረጉትን የንግድ ምክንያቶች ይወቁ።
የሶፍትዌር ሰነድ ዋና ምክንያት ተጠቃሚዎች መተግበሪያውን እንዴት እንደሚጠቀሙበት እንዲረዱ ለማገዝ ቢሆንም ፣ የገቢያ ክፍል መተግበሪያውን እንዲሸጥ መርዳት ፣ የኩባንያውን ምስል ማሻሻል እና የቴክኒክ ድጋፍን መቀነስ የመሳሰሉትን ሰነዶች እንዲፈጠሩ ሊያደርጉ የሚችሉ ሌሎች በርካታ ምክንያቶች አሉ። ወጪዎች። በአንዳንድ ሁኔታዎች ደንቦችን ወይም ሌሎች የሕግ መስፈርቶችን ለማክበር ሰነዶች ያስፈልጋሉ።
ሆኖም ፣ ሰነዶች ለበይነገጽ ጥሩ ምትክ አይደሉም። አንድ ትግበራ ለመስራት ብዙ ሰነዶች የሚፈልግ ከሆነ የበለጠ አስተዋይ እንዲሆን የተቀየሰ መሆን አለበት።
ደረጃ 2. የሰነዱን ዒላማ ታዳሚ ይወቁ።
በአጠቃላይ ፣ የሶፍትዌር ተጠቃሚዎች ከሚጠቀሙባቸው መተግበሪያዎች ውጭ የኮምፒተር ዕውቀት ውስን ነው። የሰነድ ፍላጎቶቻቸውን ለማሟላት በርካታ መንገዶች አሉ-
- ለሶፍትዌሩ ተጠቃሚ ርዕስ ትኩረት ይስጡ። ለምሳሌ ፣ የስርዓቱ አስተዳዳሪ በአጠቃላይ የተለያዩ የኮምፒተር መተግበሪያዎችን ይረዳል ፣ ፀሐፊው መረጃን ለማስገባት የሚጠቀምባቸውን መተግበሪያዎች ብቻ ያውቃል።
- ለሶፍትዌር ተጠቃሚዎች ትኩረት ይስጡ። ምንም እንኳን አቋሞቻቸው በአጠቃላይ ከተከናወኑት ተግባራት ጋር ተኳሃኝ ቢሆኑም ፣ እነዚህ የሥራ ቦታዎች በንግድ ቦታ ላይ በመመስረት የተለያዩ የሥራ ጫናዎች ሊኖራቸው ይችላል። ሊሆኑ የሚችሉ ተጠቃሚዎችን ቃለ መጠይቅ በማድረግ ፣ የሥራቸው ማዕረግ ግምገማዎ ትክክል መሆኑን ማወቅ ይችላሉ።
- ለነባር ሰነዶች ትኩረት ይስጡ። የሶፍትዌር ተግባር ሰነድ እና ዝርዝሮች ተጠቃሚዎች እነሱን ለመጠቀም ምን ማወቅ እንዳለባቸው ሊያሳዩ ይችላሉ። ሆኖም ፣ ተጠቃሚዎች የፕሮግራሙን “ውስጠኞች” የማወቅ ፍላጎት ላይኖራቸው እንደሚችል ያስታውሱ።
- አንድን ሥራ ለማጠናቀቅ ምን እንደሚያስፈልግ ፣ እና ከማጠናቀቅዎ በፊት ምን እንደሚወስድ ይወቁ።
ደረጃ 3. ለሰነዶቹ ተገቢውን ቅርጸት ይወስኑ።
የሶፍትዌር ሰነድ በ 1 ወይም በ 2 ቅርጸቶች ማለትም በማጣቀሻ መጽሐፍት እና በእጅ ማኑዋሎች ሊደራጅ ይችላል። አንዳንድ ጊዜ ሁለቱን ቅርፀቶች ማዋሃድ ጥሩ መፍትሔ ነው።
- የማጣቀሻ ቅርጸቶች እንደ አዝራሮች ፣ ትሮች ፣ መስኮች እና የንግግር ሳጥኖች እና እንዴት እንደሚሠሩ ሁሉንም የሶፍትዌር ባህሪያትን ለመግለጽ ያገለግላሉ። አንዳንድ የእገዛ ፋይሎች በዚህ ቅርጸት የተፃፉ ናቸው ፣ በተለይም ዐውደ -ጽሑፍን የሚነኩ። ተጠቃሚው በተወሰነ ማያ ገጽ ላይ እገዛን ጠቅ ሲያደርግ ተጠቃሚው የሚመለከተውን ርዕስ ይቀበላል።
- በእጅ የተሠራው ቅርጸት ከሶፍትዌሩ ጋር አንድ ነገር እንዴት ማድረግ እንደሚቻል ለማብራራት ያገለግላል። ማኑዋሎች በአጠቃላይ በሕትመት ወይም በፒዲኤፍ ቅርጸት ውስጥ ናቸው ፣ ምንም እንኳን አንዳንድ የእገዛ ገጾች አንዳንድ ነገሮችን እንዴት ማድረግ እንደሚችሉ መመሪያዎችን ያካተቱ ቢሆኑም። (በአጠቃላይ ፣ በእጅ ቅርፀቶች አውድ ስሜታዊ አይደሉም ፣ ግን ከአውድ ሚስጥራዊ ርዕሶች ጋር ሊገናኙ ይችላሉ)። የእጅ መጽሐፍት በአጠቃላይ በመመሪያ መልክ ፣ በማብራሪያ ውስጥ የሚከናወኑትን ተግባራት ማጠቃለያ እና በደረጃዎች የተቀረፀ መመሪያን ይዘዋል።
ደረጃ 4. በሰነዶች ዓይነት ላይ ይወስኑ።
ለተጠቃሚዎች የሶፍትዌር ሰነድ ከሚከተሉት ቅርፀቶች በአንዱ ወይም በብዙ ሊታሸግ ይችላል -የታተሙ ማኑዋሎች ፣ ፒዲኤፍ ፋይሎች ፣ የእገዛ ፋይሎች ወይም የመስመር ላይ እገዛ። እያንዳንዱ ዓይነት ሰነዶች መመሪያ ወይም አጋዥ ቢሆን የሶፍትዌሩን ተግባራት እንዴት እንደሚጠቀሙ ለማሳየት የተነደፈ ነው። የመስመር ላይ ሰነዶች እና የእገዛ ገጾች የማሳያ ቪዲዮዎችን ፣ ጽሑፍን እና የማይንቀሳቀሱ ምስሎችንም ሊያካትቱ ይችላሉ።
ተጠቃሚዎች የሚፈልጉትን መረጃ በፍጥነት እንዲያገኙ የመስመር ላይ እገዛ እና የድጋፍ ፋይሎች ቁልፍ ቃላትን በመጠቀም ጠቋሚ እና መፈለግ አለባቸው። ምንም እንኳን የእገዛ ፋይል ጀነሬተር ትግበራ መረጃ ጠቋሚ በራስ -ሰር መፍጠር ቢችልም ፣ አሁንም በተለምዶ የሚፈለጉ ቁልፍ ቃላትን በመጠቀም ማውጫ እራስዎ እንዲፈጥሩ ይመከራል።
ደረጃ 5. ተገቢውን የሰነድ መሣሪያ ይምረጡ።
የታተሙ ማኑዋሎች ወይም ፒዲኤፍዎች በቃሉ ማቀናበሪያ ፕሮግራም እንደ ቃል ወይም እንደ FrameMaker ባለው የላቀ የጽሑፍ አርታኢ ሊፈጥሩ ይችላሉ ፣ እንደ የፋይሉ ርዝመት እና ውስብስብነት። የእገዛ ፋይሎች እንደ RoboHelp ፣ Help and Manual ፣ Doc-to-Help ፣ Flare ፣ HelpLogix ፣ ወይም HelpServer በመሳሰሉ በእገዛ ፋይል ፈጠራ ፕሮግራም ሊፃፉ ይችላሉ።
ጠቃሚ ምክሮች
- የፕሮግራሙ ሰነድ ጽሑፍ በቀላሉ ለማንበብ በሚያስችል መንገድ መዋቀር አለበት። ምስሉን በተቻለ መጠን ወደ ተገቢው ጽሑፍ ቅርብ ያድርጉት። ሰነዶችን በክፍሎች እና በርዕሶች አመክንዮ ይሰብሩ። እያንዳንዱ ክፍል ወይም ርዕሰ ጉዳይ አንድ የተወሰነ ችግር ፣ ተግባር እና የፕሮግራም ባህሪዎች መግለፅ አለበት። ተዛማጅ ጉዳዮች በአገናኞች ወይም በማጣቀሻ ዝርዝሮች ሊብራሩ ይችላሉ።
- በዚህ ጽሑፍ ውስጥ የተገለጹት እያንዳንዱ የሰነድ መሣሪያዎች እንደ ቅጽበታዊ ገጽ እይታ ሰሪ ፕሮግራም ፣ እንደ SnagIt ያሉ ሰነዶችዎ ብዙ ቅጽበታዊ ገጽ እይታዎችን የሚሹ ከሆነ ሊሟላ ይችላል። እንደማንኛውም ሌላ ሰነድ ፣ እርስዎ ተጠቃሚውን “ከማታለል” ይልቅ መተግበሪያው እንዴት እንደሚሰራ ለማብራራት ቅጽበታዊ ገጽ እይታዎችን ማካተት አለብዎት።
- በተለይ ለዋና ተጠቃሚዎች የሶፍትዌር ሰነዶችን እየጻፉ ከሆነ ለቅጥ ትኩረት መስጠቱ በጣም አስፈላጊ ነው። “ተጠቃሚ” በሚለው ተውላጠ ስም ለተጠቃሚዎች አድራሻ ያድርጉ።
