Tafadhali bonyeza hapa kusaidia David McMurrey lipa kwa mwenyeji wa wavuti:
Toa kiasi chochote kidogo unachoweza
Uandishi wa Kiufundi mtandaoni utaendelea kuwa bure.
Ukuran huu una matengenezo.
A mwongozo wa mtumiaji ni techdoc inayofafanua jinsi ya kufanya kazi za kawaida na mtumiaji wa bidhaa. Kawaida kazi ni zile hatua ambazo mtumiaji anahitaji kuwa na uwezo wa kuzitekeleza. The mtumiaji iko katika kiwango cha maarifa na uzoefu kilichokusudiwa na bidhaa. Bidhaa nyingine zina watumiaji wa msingi na watumiaji wa hali ya juu—mwongozo wa mtumiaji unaweza kutimiza moja ya mahitaji hayo au yote mawili. Fikiria kuhusu oveni ya microwave: inaweza kuwa na mtumiaji wa msingi, na hiyo inatosha. Kwa upande mwingine, bidhaa ya kubuni picha inaweza kuwa na watumiaji wa msingi na watumiaji wa hali ya juu.
Infographic iliyotengenezwa na NotebookLLM ya sura hii
Katika sura hii, kubuni kitabu ina maana yaliyomo, mtindo, muundo, design, na mpangilio wa vipengele mbalimbali vya kawaida vya kitabu. "Vipengele" hapa vinarejelea sehemu halisi au kurasa za kitabu kama ilani ya toleo, utangulizi, kiashiria, au jalada la mbele au la nyuma. Katika sura ya kubuni ukurasa, neno kipengele inamaanisha mambo yanayoweza kutokea mara nyingi karibu popote ndani ya kitabu, kama vile vichwa vya habari, miguu, meza, michoro, orodha, matangazo, kuangazia, na kadhalika.
Ifuatayo inatoa muhtasari wa vipengele vya kawaida vya kitabu cha kiufundi kilichochapishwa na maudhui, muundo, mtindo, na mpangilio wa vipengele hivyo. Kwa hakika, hakuna mwongozo mmoja wa mtumiaji, kitabu cha rejea za kiufundi, hati ya rufaa ya haraka, au hati nyingine kama hizo ambayo itakuwa na vipengele vyote hivi vilivyoundwa na kupelekwa kwa usahihi kama unavyokuwa unasoma sasa. Badala yake, mapitio haya yatatoa muhtasari wa uwezekano—tuseme anuwai ya uwezekano.
Kumbuka: Kwa sasa, tuna mfano tu Mwongozo wa mtumiaji iliandaliwa katika FrameMaker kisha kutolewa kama PDF. Haina kamusi, lakini vipengele vyote vingine vya mwongozo wa mtumiaji wa kawaida vipo. (Siwezi kuelewa "d" katika "Filepad"!) Wajulishe kuwa haina baadhi ya mahitaji ya fonti na mipaka iliyoorodheshwa hapa chini.
Kabla hujaanza kusoma yaliyofuatayo, pata vitabu kadhaa vya vifaa na programu ili uweze kulinganisha maudhui yao, mtindo, umbile, na utaratibu na kile kinachos talked hapa.
Kwa maelezo zaidi ya kina kuliko unavyoona hapa, angalia rasilimali hizi mbili za viwango vya tasnia:
- Machapisho ya Kitaalamu ya Sun. Nisome Kwanza! Toleo lolote la karibuni. Prentice Hall.
- Kampuni ya Microsoft. Mwongozo wa Mitindo ya Microsoft kwa Uchapa wa Kitaalamu. Kila toleo la karibuni. Microsoft Press.
Unaweza kuona mifano ya vipengele hivi vya kitabu katika Mhandisi wa Techdoc.
Mifuniko ya mbele na nyuma
Nyaraka za bidhaa kwa wateja wanaolipa kawaida huwa na mabango yenye muonekano mzuri hata kama, ndani, kitabu kinakuwa cha chini kwa ubora. Kwenye bango la mbele, kwa kawaida utaona baadhi au yote ya yafuatayo:
- Jina la kampuni
- Jina la bidhaa
- Jukwaa la bidhaa au mfumo wa uendeshaji
- Nambari za toleo la bidhaa na kutolewa
- Kichwa cha Kitabu
- Alama za kampuni au bidhaa
- Alama za biashara
- Kazi ya sanaa
- Nambari ya agizo la kitabu
- kauli mbiu ya kampuni au bidhaa
Inaweza kuwa ngumu kubaini muundo mzuri wa jina la kampuni, jina la bidhaa, na jina la kitabu. Wakati mwingine, hizi zinaweza kuwa sawa na aya nzima ya maandiko! Makampuni yamegawanyika sana juu ya ikiwa kuonyesha toleo na nambari za kutolewa kwenye vifuniko vya mbele—baadhi hufanya; baadhi hawafanyi. Karibu kila wakati, hata hivyo, utaona jukwaa likionyeshwa—ikiwa bidhaa ni ya Macintosh, PC, UNIX, na kadhalika.
Mfano wa ukurasa wa kifuniko.
Ncha ya nyuma ya mwongozo wa mtumiaji wa hardcopy kawaida huwa rahisi sana. Kawaida, ina nambari ya kuagiza kitabu, jina la kampuni likiwa na ishara zinazofaa za alama ya biashara, alama ya hakimiliki na maneno yanayohusu umiliki wa kitabu, na tamko kuhusu nchi ambapo kitabu kilichapishwa. Pia utapata nambari za watu kwenye ncha ya nyuma. Angalia kama programu yako inaweza kuunda nambari ya watu—unapoweka tu kiendeshi cha nambari za watu na kuandika nambari ya kuagiza kitabu, na kiendeshi kinaunda nambari ya watu.
Ukubwa wa ukurasa
Ukurasa wa kichwa kwa kawaida ni nakala ya kifuniko cha mbele, lakini na vipengele fulani vilivyondolewa. Kwa kawaida vilivyondolewa ni sanaa, nembo za kampuni au bidhaa, na kauli mbiu. Machapisho mengine ya kiufundi yanakosa kabisa ukurasa wa kichwa kwa sababu ya kuonekana kwa nakala zisizohitajika. (Na katika uchapishaji wa nakala 20,000, ukurasa mmoja unamaanisha mengi!)
Mfano wa ukurasa wa kichwa.
Tangazo la toleo
Ilani ya toleo kawaida huwa ni mfano wa kwanza wa maandiko ya kawaida katika chapisho la kiufundi, ingawa kawaida huwa kwa herufi ndogo. Inatokea kwenye upande wa nyuma wa ukurasa wa kichwa. Ikiwa mchapishaji wa kiufundi anafuata mbinu ya rahisi na ya kijani na kuondoa ukurasa wa kichwa, ilani ya toleo itatokea kwenye upande wa nyuma wa kifuniko cha mbele.
Hakuna mtu anayeipenda kusoma maandiko madogo, lakini angalia kauli zinazojulikana mara nyingi katika arifa ya toleo:
Mfano wa tangazo la toleo
Alama za biashara
Iwe unataja alama za biashara na jinsi unavyotafsiri ni mambo ya watu wa sheria wa kampuni. Kwa hali yoyote, unataja tu majina ya bidhaa yaliyosajiliwa yanayotokea katika mwongozo huu wa mtumiaji.
Nafasi nyingi, alama za biashara zinaonyeshwa:
- katika tangazo la toleo (kama vile picha iliyo juu inaonyesha)
- katika sehemu tofauti mahali fulani ndani ya mwongozo wa mtumiaji
taja hiyo kumbukumbu
Ikiwa wanasheria wa kampuni wanataka kila tukio la jina la bidhaa iliyo na alama ya biashara kuonyeshwa kwa nyota au kifungu, jaribu kuwazungumzia kuhusu muundo huo wa ukurasa ulio na kasoro. Kujaa maandiko na nyota au nambari za viambatisho kunakera kwa wasomaji.
Dhamana
Dhamana inakabili bidhaa za vifaa vya kimwili—siyo programu. Wanasheria wa makampuni wanachukua dhima kwa lugha na muundo wa dhamana. Ikiwa unaunda mwongozo wa mfano au kitabu kwa ajili ya jalada lako, unaweza kutumia mfano huu wa "dhamana" usiotambulika.popu-up kuonyesha kwamba unatambua kuwa dhamana lazima ziwepo.
dhamana za programu?Maratibu ya Usalama
Bidhaa za vifaa mara nyingi huwa na sehemu ya matangazo ya usalama mbele ya vitabu vyao. Hizi zinaweza kutokea kama sehemu ndogo ya utangulizi, kwa mfano, au kama sehemu tofauti kwa kujitegemea. Sehemu hizi kwa kawaida huleta pamoja tahadhari za hatari, onyo, na tahadhari zinazotokea katika kitabu nzima na kuziandaa kwa namna fulani ya mantiki. Lakini hata na tahadhari hii ya mbele, vitabu vya vifaa bado vinaweka matangazo ya kibinafsi katika maeneo yanapohusiana. (Kwa maelezo zaidi, tazama) tangazo maalum.)
Tamko la mawasiliano
Vitabu vya vifaa pia vinahitaji taarifa za mawasiliano kama ilivyotajwa na serikali za nchi ambazo bidhaa hizi zinapelekwa. Nchini Marekani, FCC inahitaji taarifa fulani za mawasiliano kulingana na "daraja" la bidhaa ya vifaa. Kama mwandishi, unapaswa kuwa makini kutumia taarifa sahihi ya mawasiliano kwa bidhaa unayorekodi—na si kuhariri taarifa hiyo kwa njia yoyote (maneno ya kisheria matakatifu!).
Orodha ya maudhui
Orodha ya maudhui (TOC) kwa kawaida ina kiwango cha pili cha maelezo (vichwa 1 katika maandiko halisi) ili wasomaji waweze kupata wanachohitaji kwa usahihi zaidi. Waandishi, wahariri, na wabunifu wa vitabu kwa kawaida wanajadili kuhusu mpangilio wa TOC. Kuhusu utekelezaji, ni bora kuwa na TOC karibu na mwanzo wa kitabu iwezekanavyo, ikiwa sio kwenye mwanzo kabisa wa kitabu. Hata hivyo, kuhusu sheria, watu wanajali kwamba taarifa zote za mawasiliano, dhamana, hakimiliki, alama za biashara, na matangazo ya usalama yanapaswa kuja kwanza. Katika maeneo ambapo utekelezaji unashinda, vitabu vinatumia mbinu kila wawezavyo ili kuondoa vifaa hivi vya kisheria kutoka kwenye sehemu za mwanzo: dhamana zinawekwa kwenye kadi tofauti na kufungashiwa pamoja na kitabu au bidhaa; dhamana, taarifa za mawasiliano, alama za biashara na mengineyo yanaweza kuwekwa kwenye viambatisho.
Shida ya kuunda TOC yenye muundo mzuri? Tazama Unda Orodha ya Maudhui yenye mtindo wa kitaaluma
Orodha ya picha
Mafuta ya kiufundi kwa watumiaji wa kawaida mara nyingi hayana orodha ya picha. Kwa kweli, picha zenyewe kawaida hazina vichwa vya picha kamili. Lakini hii haimaanishi kwamba orodha ya picha haina nafasi katika mafuta ya kiufundi. Inategemea mpenzi wa kusoma na mahitaji ya mpenzi wa kusoma — na maudhui ya kitabu pia. Ikiwa kitabu kina meza, michoro, chati, grafu, na mengine ambayo wasomaji wanataka kuyapata moja kwa moja, orodha ya picha ni muhimu.
Utangulizi
Kazi ya utangulizi ni kuwaandaa wasomaji kusoma kitabu. Inafanya hivyo kwa:
- kuainisha maudhui na kusudi la kitabu
- kutambua au hata kuelezea kwa kifupi bidhaa ambayo kitabu kinaunga mkono
- akielezea aina ya msomaji ambaye kitabu kinakusudiwa kwake
- kuweka wazi yaliyomo kuu ya kitabu
- kuonyesha desturi au matumizi maalum ya istilahi yanayotumika katika kitabu
- kutoa msaada na nambari za masoko, na mengine kama hayo
Katika uchapishaji wa vitabu wa kiasilia, neno la utangulizi linakuja kabla ya jedwali la maudhui; lakini kama ilivyokuwa imejadiliwa awali katika meja ya maudhui sehemu, watu wa kuchapisha kiufundi wanataka orodha ya yaliyomo ijitokeze mapema katika kitabu kwa sababu za matumizi.
Sura za mwili
Oh ndiyo, na kuna maandiko halisi katika vitabu hivi—sio tu taarifa za mwanzo! Hakuna mengi ya kusema hapa isipokuwa vitabu vingi vya kiufundi vina sura au sehemu, na, katika baadhi ya matukio, sehemu. Tazama sura juu ya kubuni ukurasa kwa masuala ya muundo, mtindo, na kubuni kwa vipengele kama vichwa vya habari, miguu, vichwa, orodha, matangazo, meza, picha, rejea za msalaba, na kuonyesha.
Viambatano
Kama unavyojua, viambatisho ni kwa ajili ya maudhui ambayo hayafai katika sehemu kuu ya kitabu lakini hayawezi kuachwa nje ya kitabu pia. Viambatisho mara nyingi ni mahali pa meza kubwa zisizo za kawaida. Machapisho mengine ya kiufundi yana vitu kama dhamana katika viambatisho. Kuhusiana na muundo, kiambatisho ni kama sura — isipokuwa kwamba kinaitwa "Kiambatisho A" au kitu kama hicho, na vichwa na miguu ya ukurasa vinakidhi mfumo huo tofauti wa nambari na majina (A-1, A-2, na kadhalika kwa kurasa katika Kiambatisho A).
Glosari
Baadhi ya machapisho ya kiufundi yanajumuisha sehemu ya maneno maalum na maelezo yao. Zingatia kwamba kamusi nyingi hutumia muundo wa safu mbili. Kwa kawaida, kila neno na maelezo yake yanaunda aya tofauti, ambapo neno limeandikwa kwa herufi ndogo (isipokuwa ni jina maalum) na limeandikwa kwa maandiko ya kuanzia, likifuatwa na alama ya nukta, kisha maelezo katika maandiko ya kawaida. Zingatia pia kwamba maelezo kwa kawaida si sentensi kamili. Maelezo mazuri ya kamusi yanapaswa kutumia mbinu rasmi ya ufafanuzi wa sentensi kama ilivyoelezwa katika kipindi cha ufafanuzi ya maandiko haya mtandaoni. Maananiko kadhaa mara nyingi hutambuliwa kwa nambari za Kiarabu ndani ya mabano. Vifungu vya kamusi pia vina Angalia marejeleo kwa maneno yanayopendekezwa na Tazama pia m références à des termes associés.
Kielelezo
Viashiria pia kwa kawaida vina safu mbili na pia vina { Ona marejeo ya maneno yanayopendekezwa na Tazama pia rejea za maneno yanayohusiana. Tazama sura juu ya kuweka alama kwa michakato na miongozo ya kuunda viashiria vizuri.
Fomu ya jibu la msomaji
Kabla ya kuongezeka kwa Intaneti na mitandao ya kijamii, baadhi ya machapisho ya kiufundi yalikuwa na fomu za karatasi ili kuwezesha wasomaji kutuma maoni, maswali, na tathmini ya kitabu. Bila shaka, inageuka kuwa fomu hizi mara nyingi zinapata malalamiko kuhusu uendeshaji mbovu katika bidhaa ambayo kitabu kinandika. Kwa kuongezeka kwa Intaneti, fomu hizi zimehamia mtandaoni, na vitabu vinarejelea tu mahali pake mtandaoni.
Muundo wa kitabu na mpangilio
Kwa kawaida, mwongozo wa mtumiaji na miongozo iliyotengenezwa na wazalishaji wa vifaa na programu hutengenezwa kwa njia isiyo na mapambo na isiyo na mvuto. Kampuni za teknolojia ya juu zinatengeneza toleo jipya na matoleo ya bidhaa zao kila wakati baada ya miezi tisa. Katika muktadha huu, muundo wa hali ya juu hauwezi kutumika kwa ufanisi. Hapa kuna baadhi ya sifa za kawaida za mpangilio na muundo ambazo utaona:
- Ukubwa wa ukurasa mara nyingi unakabiliwa na kujali ufungaji pamoja na ukubwa wa ukurasa wa kawaida wanaopatikana na kampuni za uchapishaji. Wakati ukubwa wa ukurasa si kikwazo, baadhi ya kampuni zitatumia ukubwa wa ukurasa wa inchi 8.5 × 11—hii inafanya uzalishaji kuwa rahisi kwa waandishi.
- Kurasa zina kawaida kubuniwa kwa kurasa za kulia na za kushoto zinazobadilishana. Mguu wa ukurasa wa kushoto (sawa) unaanza na nambari ya ukurasa na kumalizia na kichwa cha kitabu. Mguu wa ukurasa wa kulia (aja) unaanza na kichwa cha sura na kumalizia na nambari ya ukurasa.
- Mazoezi yana tofauti kuhusu kama up numbering wa kurasa ni wa mfuatano katika kitabu chote au kwa kila sura.
- Isipokuwa kurasa ni ndogo, muundo wa vichwa vya habari ulio pendekezi kwa kurasa ni wa kawaida katika miaka ya kiufundi. Inama ya kuanguka kawaida ni inchi moja hadi inchi moja na nusu.
- Fonti mara nyingi ni 12-point Times New Roman kwa maandiko ya mwili na Arial kwa vichwa. Mipangilio ya mstari na nafasi kati ya maneno inatumika. Angalia sura kuhusu kuonyesha kwa matatizo mengine ya uchapishaji.
- Mipaka ni ya kawaida, inchi moja hadi mbili kote. Kawaida, inchi nusu ya ziada inatumika kwa mipaka ya ndani ili kuruhusu kushona.
- Kwa kawaida, rangi ni siyo inayotumika katika haya maelekezo na mwongozo, kawaida kutokana na masuala ya gharama na ufanisi.
Ujumbe wa kuwasilisha ni barua ya kufunika (au kumbu kumbu) au barua pepe. Barua halisi (au kumbu kumbu) imeunganishwa kwenye mwonekano wa mtumiaji kwa clip ya karatasi au imefungwa ndani ya mwonekano wa mtumiaji. Barua pepe ina kiungo cha mwonekano wa mtumiaji au mwonekano wa mtumiaji umeambatanishwa. Ni mawasiliano kutoka kwako—mwandishi wa mwonekano wa mtumiaji—hadi kwa mpokeaji, mtu aliyekuwa akiomba mwonekano wa mtumiaji na ambaye anaweza hata kuwa anakulipa kwa ushauri wako wa kitaalamu. Kimsingi, inasema "Sawa, hapa kuna mwonekano wa mtumiaji ambao tulikubaliana nimalize kabla ya tarehe fulani. Kwa ufupi, ina hiki na kile, lakini haijajumuisha hiki au kile. Tafadhali pitia na unijulishe kama inakidhi mahitaji yako."
Orodha ya Maudhui
Hesabu ya Vitu
Hata iwe ni muundo gani wa orodha ya maudhui (TOC) unayotumia, hizi ndizo viwango vya kawaida:
- Nambari ya ukurasa wa kuanzia tu. Ingawa baadhi ya watengenezaji wa TOC otomatiki wanaonyesha wigo wa ukurasa, kiwango ni nambari ya ukurasa wa kwanza tu.
- Viwango vya vichwa vya habari vinavyopaswa kujumuishwa. Kama inavyoonyeshwa katika TOC hapo juu, onyesha viwango viwili vya juu vya vichwa isipokuwa mwongozo wa mtumiaji una vichwa vidogo vingi. TOC inapaswa kutoa njia inayoweza kuangaziwa ya kupata taarifa haraka.
- Usawazishaji na matumizi ya herufi kubwa. Tazama jinsi vitu vya maandiko kwenye TOC hapo juu vimewekwa. Vichwa vya ngazi ya kwanza vinatumia herufi kubwa zote; vichwa vya ngazi ya pili vinatumia herufi za kwanza kubwa kwa kila neno kuu; vichwa vya ngazi ya tatu vinatumia mtindo wa herufi za sentensi.
- Umbali wa wima. Kumbuka kwamba sehemu za ngazi ya kwanza zina nafasi ya ziada juu na chini, ambayo inaongeza ueleweka.
Kulingana na mahitaji ya shirika lako, una chaguo mbili za muundo wa jedwali la maudhui (TOC):
Hii TOC inatumia mfumo wa nambari za decimal kwa nambari za sura na sehemu, ambayo ni ya kawaida katika miongozo ya mtumiaji. Wengine katika kitabu hiki wanatumia mfumo wa tarakimu za Roma kubwa kwa sura za kiwango cha juu pekee (ona ).
shida kuunda TOC iliyo na mpangilio mzuri? Tazama Unda Orodha ya Ndani inayoweza kuonekana kitaaluma
Vigunga na nambari za kurasa. Ikiwa muundo wa kiongozi-dot hauhitajiki na unataka kuuepuka, unaweza kutumia muundo huu unaokubalika kwa kawaida:
Tazama mfano huu wa utangulizi:
Orodha ya Maudhui rahisi, na vidokezo na nambari za ukurasa.Orodha ya picha
Siyo mara nyingi inajumuishwa katika miongozo ya watumiaji...
-->Utangulizi
Mwongozo wa Mtumiaji Sura Kuu
Viambatisho
Mlonzo
Vitu vingine vya Mwongozo wa Mtumiaji
Vichwa vya Habari
Orodha za Mchoro na Nambari
Alama, Nambari, na Fupi
Mchoro na Vichwa vya Mifano
Marejeo Mbalimbali
Uhesabu wa Kurasa
Miongozo ya Mtumiaji wa AI
Orodha za ukaguzi, ambazo kwa kawaida hazisomwi, zinaweza kutumika kama chanzo cha maelekezo ya AI kwa kubadilishwa kidogo. Nakili yafuatayo, yapaste katika mfumo wa AI kama Google's Gemini, na uone unachoweza kukosa.
Kumbuka: Marejeo yote ya maudhui, muundo, mtindo wa mwongozo wa mtumiaji au sehemu zake yanaweza kupatikana katika vitabu vya maandiko ya kiufundi mtandaoni.
Unapofanya majaribio ya kutumia AI kutathmini mradi wa uandishi, jiweke wazi, mwambie AI wewe ni nani, unataka nini. Mpe AI kipimo cha kurejelea kama vitabu vya mtandaoni. Kisha weka kile unachotaka AI ikague katika tathmini yake.
Badilisha utangulizi ili ulingane na utambulisho wako.
|
Viongozo vya Watumiaji wa AI Prompts Habari, AI. Ninakuomba uangalie maelekezo yaliyoandikwa na mwanafunzi wa mwaka wa pili wa chuo kikuu nchini Marekani. Hapa kuna muhtasari wa sura za vitabu kuhusu maelekezo na tangazo kutumia kama msingi wa tathmini yako. (Taarifa za utambulisho zimefichwa):
|
Taarifa Zilizohusiana
Jinsi ya Kuandika Mada za Msaada Zenye Rafiki kwa Watumiaji Wanaoanza. clickhelp.com
Jinsi ya kuandika nyaraka za mtumiaji. techscribe
Miongozo ya mtumiaji. techscribe
Nitathamini mawazo yako, majibu, na ukosoaji kuhusu sura hii: jibu lako—David McMurrey.
