𝗗𝗼𝗰𝘂𝗺𝗲𝗻𝘁𝗮𝘁𝗶𝗼𝗻 𝗜𝘀 𝗔 𝗙𝗲𝗮𝘁𝘂𝗿𝗲

ડોક્યુમેન્ટેશન તમારા પ્રોડક્ટથી અલગ નથી. તે પ્રોડક્ટનો જ એક ભાગ છે.

ઘણા ડેવલપર્સ એક ક્ષતિપૂર્ણ પદ્ધતિ અનુસરે છે:

  • ફીચર બનાવો.
  • ફીચરનું પરીક્ષણ કરો.
  • ફીચર લોન્ચ કરો.
  • ફીચરનું ડોક્યુમેન્ટેશન કરો.

યુઝર્સ તમારા કોડનો અનુભવ નથી કરતા. તેઓ તમારા ઇન્ટરફેસ, તમારા વર્કફ્લો અને તમારા ડોક્યુમેન્ટેશનનો અનુભવ કરે છે. યુઝર માટે, ડોક્યુમેન્ટેશન એ એક ફીચર છે.

સર્જકો ડોક્યુમેન્ટેશનની અવગણના કરે છે કારણ કે તેઓ પહેલેથી જ પ્રોડક્ટને સમજે છે. તમે જાણો છો કે તમે અમુક નિર્ણયો શા માટે લીધા હતા. તમે જાણો છો કે API કેવી રીતે કામ કરે છે. તમે શોર્ટકટ્સ જાણો છો.

યુઝર નથી જાણતા. જે તમને સ્પષ્ટ લાગે છે તે તેમને રહસ્યમય લાગે છે.

વારંવાર પૂછાતા પ્રશ્નોને 'ડોક્યુમેન્ટેશન ડેબ્ટ' (documentation debt) તરીકે ગણો. જો લોકો એક જ પ્રશ્ન બે વાર પૂછે છે, તો તમારી પાસે એક સમસ્યા છે. કાં તો તમારું પ્રોડક્ટ મૂંઝવણભર્યું છે અથવા તમારા ડોક્સ (docs) અધૂરા છે. ક્યારેક તમારે API સુધારવાની જરૂર હોય છે. ઘણીવાર, તમારે ડોક્સ સુધારવાની જરૂર હોય છે.

સારું ડોક્યુમેન્ટેશન ઘર્ષણ (friction) ઘટાડે છે. તે આ પ્રશ્નોના ઝડપથી જવાબ આપે છે:

  • આ શું છે?
  • મારે તેનો ઉપયોગ શા માટે કરવો જોઈએ?
  • હું કેવી રીતે શરૂઆત કરી શકું?
  • શ્રેષ્ઠ અભિગમ કયો છે?
  • એક સરળ ઉદાહરણ શું છે?

ધ્યેય સંપૂર્ણતા નથી. ધ્યેય ગતિ (momentum) છે.

ઉત્તમ ડોક્યુમેન્ટેશન પેટર્ન અને હેતુ શીખવે છે. તે સમજાવે છે કે એક ફ્રેમવર્ક અમુક રીતે શા માટે કામ કરે છે. આ યુઝર્સને વધુ અસરકારક બનાવે છે.

ડોક્યુમેન્ટેશન તમારા વ્યવસાય પર શાંત રીતે અસર કરે છે:

  • એડોપ્શન રેટ (Adoption rates).
  • ઓનબોર્ડિંગ સ્પીડ (Onboarding speed).
  • સપોર્ટ ખર્ચ (Support costs).
  • કોમ્યુનિટી વૃદ્ધિ (Community growth).
  • ડેવલપર અનુભવ (Developer experience).

તમે સારા ડોક્સની અસર સરળતાથી જોઈ શકતા નથી. તમે ખરાબ ડોક્સની ગેરહાજરી તરત જ નોંધી શકો છો.

યાદ રાખો કે ડોક્યુમેન્ટેશન તમારા માટે પણ છે. તે તમારા ભવિષ્યના સ્વરૂપ માટે તમારા જ્ઞાનને સાચવે છે. તે નિર્ણયોને રેકોર્ડ કરે છે જેથી તમારે મહિનાઓ પછી ફરીથી જવાબો શોધવા ન પડે.

પ્રોડક્ટની ગુણવત્તા અને ડોક્યુમેન્ટેશનની ગુણવત્તા એકબીજા સાથે જોડાયેલી છે.

  • મૂંઝવણભર્યા સોફ્ટવેરને વધુ ડોક્યુમેન્ટેશનની જરૂર હોય છે.
  • સ્પષ્ટ સોફ્ટવેરને ઓછી જરૂર હોય છે.
  • સારું ડોક્યુમેન્ટેશન ખરાબ ડિઝાઇનને ખુલ્લી પાડે છે.

ડોક્યુમેન્ટેશનને પશ્ચાત વિચાર (afterthought) તરીકે લેવાનું બંધ કરો. સ્પષ્ટતા લાવવા માટે તેનો ઉપયોગ કરો. સ્પષ્ટતા તમારી ડિઝાઇન સુધારે છે. સુધારેલી ડિઝાઇન તમારી પ્રોડક્ટ સુધારે છે.

સ્ત્રોત: https://dev.to/stinklewinks/documentation-is-a-feature-228n