ਸਿੱਖੋ ਕਿ ਇੱਕ ਸਾਫ਼ ਸਾਫਟਵੇਅਰ ਮਾਈਗ੍ਰੇਸ਼ਨ ਗਾਈਡ ਵੈਬਸਾਈਟ ਕਿਵੇਂ ਬਣਾਈ ਜਾਵੇ — ਟੈਮਪਲੇਟ, ਨੈਵੀਗੇਸ਼ਨ, SEO ਅਤੇ ਲੰਬੇ ਸਮੇਂ ਦੀ ਮੁਰੰਮਤ ਲਈ ਟਿੱਪਸ।

ਇੱਕ ਮਾਈਗ੍ਰੇਸ਼ਨ ਗਾਈਡ ਵੈਬਸਾਈਟ ਤਦ ਹੀ ਲਾਭਦਾਇਕ ਹੁੰਦੀ ਹੈ ਜਦੋਂ ਇਹ ਲੋਕਾਂ ਨੂੰ ਤੇਜ਼ੀ ਨਾਲ ਬਿਹਤਰ ਫੈਸਲੇ ਲੈਣ ਵਿੱਚ ਮਦਦ ਕਰੇ। ਇੱਕ ਵੀ ਪੰਨਾ ਲਿਖਣ ਤੋਂ ਪਹਿਲਾਂ, ਲਕੜੀ ਦੀ ਭਾਸ਼ਾ ਵਿੱਚ ਲਕੜੀ ਦਾ ਲਕੜਾ ਤੈਅ ਕਰੋ: ਖਤਰਾ ਘਟਾਉਣਾ, ਟੀਮਾਂ ਨੂੰ ਲਾਈਨ ਕਰਨਾ, ਅਤੇ ਕਿਰਿਆਵਾਈ ਦੀ ਗਤੀ ਤੇਜ਼ ਕਰਨਾ। ਇਹ ਲਕੜਾ ਤੁਹਾਡੇ ਪ੍ਰਕਾਸ਼ਨ (ਅਤੇ ਜੋ ਤੁਸੀਂ ਛੱਡਦੇ ਹੋ) ਲਈ ਛਣਣੀ ਦਾ ਕੰਮ ਕਰੇਗਾ।
ਜ਼ਿਆਦਾਤਰ ਮਾਈਗ੍ਰੇਸ਼ਨ ਪ੍ਰੋਜੈਕਟਾਂ ਦੇ ਕਈ ਪੜ੍ਹਨ ਵਾਲੇ ਹੁੰਦੇ ਹਨ ਜਿਨ੍ਹਾਂ ਦੇ ਸਵਾਲ ਅਤੇ ਵਕਤ ਬਜਟ ਵੱਖ-ਵੱਖ ਹੁੰਦੇ ਹਨ। ਉਨ੍ਹਾਂ ਨੂੰ ਖੁੱਲ੍ਹ ਕੇ ਨਾਮ ਦਿਓ ਤਾਂ ਜੋ ਤੁਹਾਡੀ ਸਮੱਗਰੀ ਜੇਹੀ ਨਾ ਲੱਗੇ:
ਜੇ ਤੁਸੀਂ ਹਰ ਦਰਸ਼ਕ ਦੇ ਸਿਖਰ ਦੇ 3 ਸਵਾਲ ਵਰਣਨ ਨਹੀਂ ਕਰ ਸਕਦੇ, ਤਾਂ сайт_generic ਮਹਿਸੂਸ ਹੋ ਸਕਦੀ ਹੈ।
ਛੋਟਾ "ਇਹ ਸਾਈਟ ਕੀ ਕਵਰ ਕਰਦੀ ਹੈ" ਬਿਆਨ ਲਿਖੋ, ਫਿਰ ਮਿਲਦੇ-ਜੁਲਦੇ "ਇਹ ਸਾਈਟ ਕੀ ਨਹੀਂ ਕਵਰ ਕਰਦੀ" ਸ਼ਾਮِل ਕਰੋ। ਉਦਾਹਰਨ ਵਜੋਂ: ਸਾਈਟ ਸਮਰਥਿਤ ਪਾਥ, ਡੇਟਾ ਮੈਪਿੰਗ, ਅਤੇ ਵੈਰੀਫਿਕੇਸ਼ਨ ਕਵਰ ਕਰ ਸਕਦੀ ਹੈ, ਪਰ ਨਹੀਂ ਕਸਟਮ ਕਨਸਲਟਿੰਗ ਸਲਾਹ, ਤੀਜੀ-ਪੱਖ ਸਪਲਾਇਰ ਠੇਕੇ, ਜਾਂ ਹਰ ਐਜ ਕੇਸ।
ਇਸ ਨਾਲ ਮਦਦ ਮਿਲਦੀ ਹੈ ਕਿ ਗਾਈਡ ਭਰੋਸੇਯੋਗ ਰਹੇ ਅਤੇ ਬਣੇ-ਬਣਾਏ ਇੱਕ-ਆਫ ਐਡਿਸ਼ਨਾਂ ਨਾਲ ਭਰ ਨਾ ਜਾਵੇ।
ਸਫਲਤਾ ਕੇਵਲ ਪੰਨਾਂ ਦੀ ਗਿਣਤੀ ਨਹੀਂ ਹੋਣੀ ਚਾਹੀਦੀ। ਉਦਾਹਰਨਾਂ:
ਇੱਕ ਇੱਕਲ ਐਂਟਰੀ ਪੇਜ਼ ਬਣਾਓ (ਉਦਾਹਰਨ: /start-here) ਜਿਸ 'ਤੇ ਰੁਖਣ ਲਈ ਘੱਟੋ-ਘੱਟ ਕਦਮ ਹੋਣ: ਇਹ ਗਾਈਡ ਕਿਸ ਲਈ ਹੈ, ਸਿਫ਼ਾਰਸ਼ ਕੀਤੀ ਮਾਈਗ੍ਰੇਸ਼ਨ ਪਾਥ, ਅਹੰਕਾਰਕ ਪੂਰਵ-ਸ਼ਰਤਾਂ, ਅਤੇ ਮਾਈਗ੍ਰੇਸ਼ਨ ਚੈੱਕਲਿਸਟ ਪੇਜ਼ ਕਿੱਥੇ ਮਿਲੇਗੀ। ਇਹ ਉਲਝਣ ਘਟਾਉਂਦਾ ਅਤੇ ਸ਼ੁਰੂ ਵਿੱਚ ਹੀ ਹਿੱਸੇਦਾਰਾਂ ਨੂੰ ਇਕ-ਲੇਬਲ 'ਤੇ ਲਿਆਉਂਦਾ।
ਇੱਕ ਮਾਈਗ੍ਰੇਸ਼ਨ ਗਾਈਡ ਉਸ ਵੇਲੇ ਸਫਲ ਹੁੰਦੀ ਹੈ ਜਦੋਂ ਪੜ੍ਹਨ ਵਾਲਾ ਸਹੀ ਨਿਰਦੇਸ਼ ਸੈਕਿੰਡਾਂ ਵਿੱਚ ਲੱਭ ਸਕੇ—ਖਾਸਕਰ ਜਦੋਂ ਸਮੇਤ ਦਬਾਅ ਹੋਵੇ। ਜਾਣਕਾਰੀ ਆਰਕੀਟੈਕਚਰ (IA) ਉਹ ਯੋਜਨਾ ਹੈ ਜੋ ਤੁਹਾਡੇ ਸਮੱਗਰੀ ਨੂੰ ਅਨੁਮਾਨਯੋਗ ਬਣਾਉਂਦੀ: ਇੱਕੋ ਕਿਸਮ ਦੇ ਪੰਨੇ ਹਮੇਸ਼ਾਂ ਇੱਕੋ ਥਾਂ ਰਹਿੰਦੇ ਹਨ, ਅਤੇ URL ਉਹ ਕੰਮ ਦੇ ਸੰਗਤ ਹੁੰਦੇ ਹਨ ਜੋ ਕੋਈ ਕਰਨ ਦੀ ਕੋਸ਼ਿਸ਼ ਕਰ ਰਿਹਾ ਹੈ।
ਜ਼ਿਆਦਾਤਰ ਸਾਫਟਵੇਅਰ ਮਾਈਗ੍ਰੇਸ਼ਨਾਂ ਲਈ, ਇੱਕ ਸਪਸ਼ਟ ਫੇਜ਼-ਅਧਾਰਤ ਢਾਂਚਾ ਸਭ ਤੋਂ ਵਧੀਆ ਕੰਮ ਕਰਦਾ ਹੈ:
ਇਸ ਨਾਲ ਸਾਈਟ ਮਾਈਗ੍ਰੇਸ਼ਨਾਂ ਦੇ ਤਰੀਕੇ ਨਾਲ ਸੰਗਤ ਰਹਿੰਦੀ ਹੈ ਅਤੇ ਨਾਨ-ਟੈਕਨੀਕਲ ਪਾਠਕਾਂ ਨੂੰ ਸਮਝਣ ਵਿੱਚ ਆਸਾਨੀ ਹੁੰਦੀ ਹੈ ਕਿ ਉਹ ਯਾਤਰਾ ਵਿੱਚ ਕਿੱਥੇ ਹਨ।
ਚੈੱਕਲਿਸਟ, ਟੈਮਪਲੇਟ, ਅਤੇ FAQs ਕੀਮਤੀ ਹਨ—ਪਰ ਉਹ ਕਦਮ-ਦਰ-ਕਦਮ ਪੰਨਿਆਂ ਨੂੰ ਭਰ ਨਹੀਂ ਦੇਣੇ ਚਾਹੀਦੇ।
ਅਲੱਗ ਹਬ ਬਣਾਓ ਜੋ ਤੁਸੀਂ ਕਈ ਥਾਵਾਂ ਤੋਂ ਲਿੰਕ ਕਰ ਸਕੋ, ਉਦਾਹਰਨ:
/guide/checklists/ ਲਈ “migration checklist page” ਸਮੱਗਰੀ (cutover, rollback, data verification)/guide/templates/ ਲਈ ਸਪ੍ਰੈਡਸ਼ੀਟਾਂ, ਈਮੇਲ ਡਰਾਫਟ, ਸਟੇਕਹੋਲਡਰ ਸੰਚਾਰ, ਮੀਟਿੰਗ ਏਜੰਡੇ/guide/faq/ ਲਈ ਦੁਹਰਾਏ ਸਵਾਲ ਅਤੇ ਐਜ ਕੇਸਇਸ ਨਾਲ ਡੁਪਲੀਕੇਸ਼ਨ ਘਟਦਾ ਹੈ ਅਤੇ ਜਦੋਂ ਲੋੜ ਬਦਲੇ ਤਾਂ ਅਪਡੇਟ ਸੁਰੱਖਿਅਤ ਹੁੰਦੇ ਹਨ।
ਸ਼ੁਰੂ ਵਿੱਚ ਹੀ ਇੱਕ URL ਸਕੀਮ ਚੁਣੋ ਅਤੇ ਉਸ ਨਾਲ ਟਿਕੇ ਰਹੋ। ਇੱਕ ਚੰਗਾ ਡਿਫ਼ਾਲਟ ਇਹ ਹੈ:
/guide/<phase>/<topic>//guide/prepare/data-export/ਲਗਾਤਾਰ URLs ਤੁਹਾਡੇ ਮਾਈਗ੍ਰੇਸ਼ਨ ਡੌਕਯੂਮੈਂਟੇਸ਼ਨ ਸਾਈਟ ਨੂੰ ਨੈਵੀਗੇਟ ਕਰਨਯੋਗ, ਖੋਜਯੋਗ ਅਤੇ ਮਸਤੂ ਰਹਿਤ ਬਣਾਉਂਦੇ ਹਨ।
ਹਰ ਕੋਈ ਇੱਕੋ ਤਰੀਕੇ ਨਾਲ ਗਾਈਡ ਨਹੀਂ ਪੜ੍ਹਦਾ। ਹਿੱਸੇਦਾਰ ਅਕਸਰ ਨਤੀਜੇ, ਜੋਖਮ ਅਤੇ ਟਾਈਮਲਾਈਨ ਦੇਖਣਾ ਚਾਹੁੰਦੇ ਹਨ, ਜਦਕਿ ਇੰਪਲੀਮੈਂਟਰ ਸਰਗਰਮ ਨਿਰਦੇਸ਼ ਚਾਹੁੰਦੇ ਹਨ।
ਦੋਹਾਂ ਨੂੰ ਸਹਾਇਤਾ ਕਰੋ:
ਇਨ੍ਹਾਂ ਵਿਚਕਾਰ ਵੱਡੇ ਲਿੰਕ ਰੱਖੋ ਤਾਂ ਕਿ ਪੜ੍ਹਨ ਵਾਲਾ ਬਿਨਾਂ ਆਪਣੀ ਜਗ੍ਹਾ ਖੋਏ ਮੋਡ ਬਦਲ ਸਕੇ।
ਇੱਕ ਸਾਰਾਂਸ਼ ਪੇਜ਼ ਜੋ ਹਿੱਸੇਦਾਰਾਂ ਦੇ ਸਵਾਲ ਫੁੱਟੀ ਤਰ੍ਹਾਂ ਜਵਾਬ ਦੇਵੇ: ਦਾਇਰਾ, ਟਾਈਮਲਾਈਨ, ਮੁੱਖ ਫੈਸਲੇ, ਮਲਕੀਅਤ, ਜੋਖਮ ਖੇਤਰ, ਅਤੇ ਇੱਕ ਛੋਟੀ ਸਥਿਤੀ ਚੈੱਕਲਿਸਟ। ਇਸਨੂੰ ਢਾਂਚੇ ਵਿੱਚ ਉੱਚੇ ਸਥਾਨ (/guide/at-a-glance/) ਤੇ ਰੱਖੋ ਅਤੇ ਗਾਈਡ ਹੋਮ ਤੋਂ ਲਿੰਕ ਕਰੋ।
ਜਦੋਂ ਤੁਹਾਡੀ ਵੈਬਸਾਈਟ ਸੱਚੇ ਮਾਈਗ੍ਰੇਸ਼ਨ ਫੇਜ਼ਾਂ ਨੂੰ ਨਕਲ ਕਰਦੀ ਹੈ—ਅਤੇ ਸੰਦਰਭ ਸਮੱਗਰੀ ਨੂੰ ਪ੍ਰਕਿਰਯਾਵਾਂ ਤੋਂ ਅਲੱਗ ਕਰਦੀ ਹੈ—ਤਾਂ ਤੁਹਾਡੀ ਸਮੱਗਰੀ ਭਰੋਸੇਯੋਗ ਅਤੇ ਤੇਜ਼ ਵਰਤੀ ਜਾਣਯੋਗ ਬਣ ਜਾਂਦੀ ਹੈ।
ਇੱਕ ਮਾਈਗ੍ਰੇਸ਼ਨ ਗਾਈਡ ਵਧੀਆ ਪੜ੍ਹਦੇ ਸਮੇਂ ਉਹੀ ਪੇਜ਼ ਬਣਦਾ ਹੈ ਜੋ ਲੋਕ ਅਸਲ ਵਿੱਚ ਮਾਈਗ੍ਰੇਸ਼ਨ ਚਲਾਉਂਦੇ ਸਮੇਂ ਵਰਤਦੇ ਹਨ। ਪ੍ਰੋਡਕਟ ਵਿਸ਼ੇਸ਼ਤਾਵਾਂ ਦੇ ਬਜਾਏ, ਫੇਜ਼ਾਂ ਦੇ ਅਨੁਸਾਰ ਵਿਵਸਥਾ ਕਰੋ—ਤਾਂ ਕਿ ਪਾਠਕ ਜਦੋਂ ਸਾਈਟ ਖੋਲ੍ਹੇ ਤਾਂ ਉਹ ਦਰਜੇ 'ਤੇ ਹੋਕੇ ਅੱਗੇ ਕਰਨ ਯੋਗ ਕੰਮ ਵੇਖ ਸਕੇ।
ਹਰੇਕ ਫੇਜ਼ ਲਈ ਇੱਕ ਸਿਖਰ-ਸਤਹ ਖੰਡ ਬਣਾਓ, ਹਰ ਇੱਕ ਵਿੱਚ ਇੱਕੋ ਤਰ੍ਹਾਂ ਦੇ ਪੰਨੇ (ਓਵਰਵਿਊ, ਚੈੱਕਲਿਸਟ, ਡਿਲਿਵਰੇਬਲ, ਅਤੇ “ਚੰਗਾ ਕੀ ਹੁੰਦਾ”):
ਜੇ ਤੁਸੀਂ ਚੈੱਕਲਿਸਟ ਵਰਤਦੇ ਹੋ, ਉਹਨਾਂ ਨੂੰ ਨਿਰਧਾਰਤ ਪੰਨਿਆਂ ਵਜੋਂ ਰੱਖੋ (ਉਦਾਹਰਨ: “Cutover checklist” ਪੇਜ਼) ਤਾਂ ਜੋ ਪ੍ਰਿੰਟ ਜਾਂ ਸਾਂਝਾ ਕਰਨਾ ਆਸਾਨ ਹੋਵੇ।
ਫੇਜ਼ ਸਮੱਗਰੀ ਤੱਕ ਪਹੁੰਚ ਕਰਨ ਤੋਂ ਪਹਿਲਾਂ, ਉਨਾਂ ਨੂੰ ਛੋਟਾ "Start here" ਸੈੱਟ ਦਿਓ:
ਮਾਈਗ੍ਰੇਸ਼ਨਾਂ ਵਿੱਚ ਰਸਤੇ 'ਚ ਫੋਰਕ ਆਉਂਦੇ ਹਨ। ਫੈਸਲਾ ਪੰਨੇ ਸਿੱਧੇ ਸੰਬੰਧਤ ਫੇਜ਼ ਦੇ ਅੰਦਰ ਰੱਖੋ:
"Common scenarios" ਹਬ ਸ਼ਾਮਲ ਕਰੋ ਜੋ ਇੱਕੋ ਗਾਈਡ ਨੂੰ ਵੱਖ-ਵੱਖ ਪ੍ਰਸੰਗਾਂ ਲਈ ਅਨুকੂਲ ਕਰਦਾ ਹੈ:
ਅੰਤ ਵਿੱਚ, ਟ੍ਰਬਲਸ਼ੂਟਿੰਗ ਅਤੇ ਰੋਲਬੈਕ ਨੂੰ ਇੱਕ ਪਹਿਲੀ-ਕਲਾਸ ਸਮੱਗਰੀ ਵਜੋਂ ਰੱਖੋ, ਨਾ ਕਿ ਪੈਰੂ-ਐਪੈਂਡਿਕਸ: ਹਰ ਫੇਜ਼ چੈੱਕਲਿਸਟ ਤੋਂ ਰੋਲਬੈਕ ਕਦਮਾਂ ਦੇ ਲਿੰਕ ਰੱਖੋ, ਅਤੇ ਇੱਕ ਸਿੰਗਲ "Rollback procedure" ਪੇਜ਼ ਰੱਖੋ ਜੋ ਘਟਨਾਵਾਂ ਦੌਰਾਨ ਆਸਾਨੀ ਨਾਲ ਮਿਲ ਜਾਵੇ।
ਟੈਮਪਲੇਟ ਮਾਈਗ੍ਰੇਸ਼ਨ ਗਾਈਡ ਨੂੰ ਪੰਨਿਆਂ ਦੇ ਢੇਰ ਤੋਂ ਇਕ ਅਨੁਮਾਨਯੋਗ ਅਨੁਭਵ ਬਣਾਉਂਦੇ ਹਨ। ਪੜ੍ਹਨ ਵਾਲੇ ਨੂੰ ਹਰ ਪੰਨੇ 'ਤੇ ਤੁਹਾਡੇ ਦਸਤਾਵੇਜ਼ ਨੂੰ "ਸਿੱਖਣਾ" ਨਹੀਂ ਚਾਹੀਦਾ—ਉਹ ਤੁਰੰਤ ਢਾਂਚਾ ਪਛਾਣਣ, ਜੋ ਲੋੜ ਹੈ ਉਹ ਲੱਭਣ ਅਤੇ ਅੱਗੇ ਕੀ ਕਰਨਾ ਹੈ ਇਹ ਜਾਣਣ ਯੋਗ ਹੋਣ।
ਹਰੇਕ ਮਾਈਗ੍ਰੇਸ਼ਨ (ਜਾਂ ਹਰੇਕ ਮੁਖ ਫੇਜ਼) ਲਈ ਇੱਕ ਲਗਾਤਾਰ ਓਵਰਵਿਊ ਫਾਰਮੈਟ ਵਰਤੋ। ਇਸਨੂੰ ਸਕੈਨ ਕਰਨਯੋਗ ਰੱਖੋ:
ਸਾਫ਼ ਕਾਲ-ਟੂ-ਐਕਸ਼ਨ ਨਾਲ ਖਤਮ ਕਰੋ, ਉਦਾਹਰਨ "Start pre-migration checks" ਜੋ /checklists/pre-migration ਨੂੰ ਲਿੰਕ ਕਰਦਾ ਹੈ।
ਇੱਕ ਸਟੇਪ ਪੇਜ਼ ਰੇਸੀਪੀ ਵਾਂਗ ਪੜ੍ਹਨਾ ਚਾਹੀਦਾ ਹੈ, ਨ ਕਿ ਨਾਵਲ ਵਾਂਗ। ਸੁਝਾਏ ਹਿੱਸੇ:
ਜਦੋਂ ਜਾਣਿਆ-ਪਹਚਾਨਾ ਆਮ ਤੌਰ 'ਤੇ ਤਰੱਕੀਆਂ ਹੋਣ, ਇਸ 'ਚ ਛੋਟਾ "Troubleshooting" ਕਾਲਆਉਟ ਜੋੜੋ।
ਚੈੱਕਲਿਸਟ ਕੋਆਰਡੀਨੈਸ਼ਨ ਨਾ-ਸਫਲਤਾਵਾਂ ਘਟਾਉਂਦੇ ਹਨ। ਉਨ੍ਹਾਂ ਨੂੰ ਇੱਕ ਟੇਬਲ ਵਜੋਂ ਸੰਰਚਿਤ ਕਰੋ:
ਇਸ ਨਾਲ ਤੁਹਾਡੀ "migration checklist page" ਮੀਟਿੰਗਾਂ ਵਿੱਚ ਵਰਤਣਯੋਗ ਅਤੇ ਪ੍ਰਿੰਟ ਕਰਨਯੋਗ ਬਣ ਜਾਂਦੀ ਹੈ।
ਸੰਦਰਭ ਪੰਨੇ ਸਖ਼ਤ ਅਤੇ ਤੱਥ-ਅਧਾਰਤ ਹੋਣੇ ਚਾਹੀਦੇ ਹਨ। ਸ਼ਾਮਿਲ ਕਰੋ:
ਜਵਾਬ ਛੋਟੇ ਰੱਖੋ, ਫਿਰ ਗਹਿਰਾਈ ਲਈ ਲਿੰਕ ਦਿਓ:
ਤੁਸੀਂ ਇਨ੍ਹਾਂ ਟੈਮਪਲੇਟਾਂ ਨੂੰ ਆਪਣੇ CMS ਵਿੱਚ ਸ਼ੁਰੂਆਤੀ ਪੰਨਿਆਂ ਵਜੋਂ ਰੱਖ ਸਕਦੇ ਹੋ ਤਾਂ ਹਰ ਨਵੇਂ ਪੰਨੇ ਦੀ ਸ਼ੁਰੂਆਤ ਸਹੀ ਢਾਂਚੇ ਨਾਲ ਹੋਵੇ।
ਇੱਕ ਮਾਈਗ੍ਰੇਸ਼ਨ ਗਾਈਡ ਉਸ ਵੇਲੇ ਸਫਲ ਹੁੰਦੀ ਹੈ ਜਦੋਂ ਪੜ੍ਹਨ ਵਾਲਾ ਦੋ ਸਵਾਲ ਤੁਰੰਤ ਜਵਾਬ ਦੇ ਸਕੇ: "ਮੈਂ ਕਿੱਥੇ ਹਾਂ?" ਅਤੇ "ਅੱਗੇ ਕੀ ਕਰਨਾ ਹੈ?" ਚੰਗੀ ਨੈਵੀਗੇਸ਼ਨ ਡਰੌਪ-ਆਫ ਘਟਾਉਂਦੀ ਹੈ, ਸਹਾਇਤਾ ਟਿਕਟਾਂ ਘਟਾਉਂਦੀ ਹੈ, ਅਤੇ ਨਾਨ-ਟੈਕਨੀਕਲ ਪਾਠਕਾਂ ਨੂੰ ਕਦਮ-ਦਰ-ਕਦਮ ਆਤਮ-ਵਿਸ਼ਵਾਸ ਰੱਖਣ ਵਿੱਚ ਮਦਦ ਕਰਦੀ ਹੈ।
ਟੌਪ ਨੈਵੀਗੇਸ਼ਨ ਨੂੰ ਸਧਾਰਨ ਅਤੇ ਕਾਰਜ-ਕੇਂਦਰਿਤ ਰੱਖੋ। ਇੱਕ ਮਜ਼ਬੂਤ ਬੇਸਲਾਈਨ:
ਇਹ ਢਾਂਚਾ ਵੱਖ-ਵੱਖ ਦਰਸ਼ਕਾਂ ਨੂੰ ਬਿਨਾਂ ਪੂਰੇ ਗਾਈਡ ਵਿੱਚ ਖੋਜ ਕੀਤੇ ਇਹ ਜਾਣਨ ਵਿੱਚ ਮਦਦ ਕਰਦਾ ਹੈ ਕਿ ਉਹਨੂੰ ਕੀ ਲੋੜ ਹੈ।
ਮੁੱਖ Guide ਲਈ, ਖੱਬੇ-ਪਾਸੇ ਨੈਵੀਗੇਸ਼ਨ ਵਰਤੋ ਜੋ ਕਦਮਾਂ ਨੂੰ ਮਾਨਨੇਯੋਗ ਫੇਜ਼ਾਂ ਵਿੱਚ ਗਰੁੱਪ ਕਰਦਾ ਹੈ (ਉਦਾਹਰਨ: Prepare → Test → Migrate → Validate)। ਗਰੁੱਪਿੰਗ ਦਿਖਾਓ ਤਾਂ ਕਿ ਪੜ੍ਹਨ ਵਾਲਾ ਤਰੱਕੀ ਮਹਿਸੂਸ ਕਰੇ, ਸਿਰਫ ਲੰਬੀ ਸੂਚੀ ਨਹੀਂ।
ਜੇ ਸੰਭਵ ਹੋਵੇ, ਹਾਈਲਾਈਟ ਕਰੋ:
ਪੰਨੇ ਦੇ ਉਪਰ ਇੱਕ ਪ੍ਰਮੁੱਖ ਖੋਜ ਬਾਕਸ ਰੱਖੋ, ਅਤੇ ਜੇ ਪਲੇਟਫਾਰਮ ਸਮਰਥਨ ਕਰਦਾ ਹੈ ਤਾਂ autocomplete ਚਾਲੂ ਕਰੋ। Autocomplete ਲੋਕਾਂ ਨੂੰ ਸਹੀ ਸ਼ਬਦਾਂ ਦੀ ਨਸੀਹਤ ਦਿੰਦਾ ਹੈ (ਜਿਵੇਂ "SSO", "data export", "rollback") ਅਤੇ "ਕੋਈ ਨਤੀਜਾ ਨਹੀਂ" ਫ੍ਰੈਸਟਰੇਸ਼ਨ ਨੂੰ ਘਟਾਉਂਦਾ ਹੈ।
Breadcrumbs ਵਰਤੋਂ ਤਾਂ ਕਿ ਪੜ੍ਹਨ ਵਾਲਾ ਬਿਨਾਂ ਸੰਦਰਭ ਗੁਆਏ ਮੁੜ ਸਕੇ।
ਹਰ ਸਟੇਪ ਪੇਜ਼ ਦੇ ਤਲੀਏ ਸਾਫ਼ "Next step" ਅਤੇ "Previous step" ਲਿੰਕ ਸ਼ਾਮਿਲ ਕਰੋ। ਇਹ ਛੋਟੀ ਡੀਟੇਲ ਭਰਪਾਈ ਰੱਖਦੀ ਹੈ ਅਤੇ ਪੜ੍ਹਨ ਵਾਲੇ ਨੂੰ ਹਰ ਕੰਮ ਪਿੱਛੋਂ ਮੈਨੂ 'ਤੇ ਵਾਪਸ ਜਾਣ ਤੋਂ ਬਚਾਉਂਦੀ।
ਇੱਕ ਮਾਈਗ੍ਰੇਸ਼ਨ ਗਾਈਡ ਤਦ ਹੀ ਸਫਲ ਹੁੰਦੀ ਹੈ ਜਦੋਂ ਲੋਕ ਇਸ 'ਤੇ ਤੇਜ਼ੀ ਨਾਲ ਕੰਮ ਕਰ ਸਕਣ। ਲਿਖੋ ਜਿਵੇਂ ਕਿ ਪਾਠਕ ਤੇਜ਼-ਚਿੰਤਕ ਹੈ: ਛੋਟੀ ਵਾਕ-ਰਚਨਾ, ਇੱਕ ਪੈਰਾਗ੍ਰਾਫ ਵਿੱਚ ਇੱਕ ਵਿਚਾਰ, ਅਤੇ ਹਰ ਪੰਨੇ ਦੇ ਅੰਤ 'ਤੇ ਇੱਕ ਸਪਸ਼ਟ "ਅੱਗੇ ਕੀ ਕਰਨਾ ਹੈ"।
ਅਕ੍ਰੋਨਿਮ ਪਹਿਲੀ ਵਾਰੀ ਵਰਤੇ ਜਾਣ 'ਤੇ ਪਰਿਭਾਸ਼ਿਤ ਕਰੋ (ਉਦਾਹਰਨ: "SSO (single sign-on)")। ਸਾਫ਼ ਕਿਰਿਆ-ਸ਼ਬਦਾਂ ਨੂੰ ਤਰਜੀਹ ਦਿਓ ("export", "map", "validate") ਬਜਾਏ ਅਬਸਟ੍ਰੈਕਟ ਫਰੇਜ਼ ਦੇ। ਜੇ ਕਿਸੇ ਉਤਪਾਦ-ਖਾਸ ਸ਼ਬਦ ਦੀ ਲੋੜ ਹੋਵੇ, ਉਸ ਦੇ ਹੇਠਾਂ ਇੱਕ ਇੱਕ-ਲਾਈਨ ਵਿਆਖਿਆ ਜੋੜੋ।
ਵਿਜ਼ੂਅਲ ਉਹਨਾਂ ਲਈ ਸਭ ਤੋਂ ਵਧੀਆ ਹਨ ਜਦੋਂ ਉਹ ਸਿਮਾਵਾਂ ਅਤੇ ਫਲੋ ਨੂੰ ਸਮਝਾਉਂਦੇ ਹਨ। ਸਧਾਰਨ ਡਾਇਗ੍ਰਾਮਾਂ ਜੋੜੋ:
ਹਰੇਕ ਡਾਇਗ੍ਰਾਮ ਲਈ ਇੱਕ ਕਾਰਜਪੂਰਨ ਕੈਪਸ਼ਨ ਰੱਖੋ: ਪੜ੍ਹਨ ਵਾਲੇ ਨੂੰ ਕੀ ਧਿਆਨ ਦੇਣਾ ਚਾਹੀਦਾ ਹੈ (“Customer IDs are generated in the new CRM, not imported”). ਜੇ ਵਿਜ਼ੂਅਲ ਸਪਸ਼ਟ ਨਹੀਂ, ਤਾਂ ਹੇਠਾਂ 2–3 ਵਾਕਾਂ ਦੀ ਵਿਆਖਿਆ ਜੋੜੋ।
ਫੀਲਡ ਅਤੇ ਓਬਜੇਕਟ ਮੈਪਿੰਗ ਟੇਬਲ ਵਿੱਚ ਪੜ੍ਹਨਾ ਆਸਾਨ ਹੁੰਦਾ ਹੈ। ਇਕੋ ਢਾਂਚਾ ਵਰਤੋ:
| ਪੁਰਾਣਾ ਫੀਲਡ | ਨਵਾਂ ਫੀਲਡ | ਰੂਪਾਂਤਰ ਨਿਯਮ | ਉਦਾਹਰਨ |
|---|---|---|---|
acct_id | accountId | 10 ਅੰਕਾਂ ਤੱਕ ਪੈਡ ਕਰੋ | 123 → 0000000123 |
ਐਜ ਕੇਸ (ਖਾਲੀ ਮੁੱਲ, ਖ਼ਾਸ ਅੱਖਰ, ਟਾਈਮ ਜੋਨ) ਸ਼ਾਮਿਲ ਕਰੋ ਕਿਉਂਕਿ ਇੱਥੇ ਮਾਈਗ੍ਰੇਸ਼ਨਾਂ ਅਕਸਰ ਫੇਲ ਹੁੰਦੀਆਂ ਹਨ।
ਪੜ੍ਹਨ ਵਾਲੇ "ਤੁਰੰਤ ਚਲਾਉਣ ਯੋਗ" ਬਲੌਕਾਂ ਨੂੰ ਪਸੰਦ ਕਰਦੇ ਹਨ, ਪਰ ਉਹਨਾਂ ਨੂੰ ਪ੍ਰਸੰਗ ਚਾਹੀਦਾ ਹੈ: ਪੂਰਵ-ਸ਼ਰਤ, ਕਿੱਥੇ ਚਲਾਉਣਾ ਹੈ, ਅਤੇ ਕਾਮਯਾਬੀ ਕੀ ਦਿਖੇਗੀ।
# Export users from the old system
oldsys export users --format=csv --out=users.csv
ਹਰ ਵਾਰ ਪੂਰਵ-ਸ਼ਰਤਾਂ, ਚੇਤਾਵਨੀ, ਅਤੇ "ਰੋਕੋ/ਰੋਲਬੈਕ" ਸਥਿਤੀਆਂ ਲਈ ਇੱਕੋ ਹੀ ਕਾਲਆਉਟ ਸ਼ੈਲੀ ਵਰਤੋ। ਸੰਗਤਤਾ ਪੜ੍ਹਨ ਵਾਲੇ ਨੂੰ ਖਤਰੇ ਨੂੰ ਖਿੱਚਣ ਤੋਂ ਪਹਿਲਾਂ ਪਛਾਣਣ ਵਿੱਚ ਮਦਦ ਕਰਦੀ ਹੈ।
ਇੰਟਰਐਕਟਿਵ ਫੀਚਰ ਥੋੜ੍ਹੇ-ਪ੍ਰਯੋਗਿਕ ਤਰੀਕੇ ਨਾਲ ਗਾਈਡ ਨੂੰ "ਜਿਂਦਾ" ਮਹਿਸੂਸ ਕਰਵਾ ਸਕਦੇ ਹਨ—ਪਰ ਸਿਰਫ ਜੇ ਉਹ ਪੜ੍ਹਨ ਵਾਲੇ ਦਾ ਕੰਮ ਘਟਾਉਂਦੇ ਹੋਣ। мақਸਦ ਐਪ ਬਣਾਉਣਾ ਨਹੀਂ; ਇਹ ਹੈ ਕਿ ਮਹੱਤਵਪੂਰਨ ਪੰਨਿਆਂ ਨੂੰ ਉਹ ਟੂਲ ਬਨਾਉਣਾ ਜੋ ਲੋਕ ਯੋਜਨਾ, ਕਾਰਗੁਜ਼ਾਰੀ, ਅਤੇ ਤਸਦੀਕ ਦੌਰਾਨ ਵਰਤ ਸਕਣ।
ਇੰਟਰਐਕਟਿਵ ਚੈੱਕਲਿਸਟ (ਪ੍ਰਿੰਟੇਬਲ + ਡਾਊਨਲੋਡਯੋਗ): ਪੇਜ਼ 'ਤੇ ਇੱਕ ਚੈੱਕਲਿਸਟ ਰੱਖੋ ਜੋ ਤੇਜ਼ੀ ਨਾਲ ਪ੍ਰਗਤੀ ਟਰੈਕ ਕਰਨ ਲਈ ਹੋਵੇ, ਅਤੇ ਟੀਮਾਂ ਲਈ ਸਪ੍ਰੈਡਸ਼ੀਟ ਡਾਊਨਲੋਡ ਦੀਆਂ ਵਿਕਲਪ ਦਿੱਤੀਆਂ ਹਨ। ਦਿਓ:
ਚੈੱਕਲਿਸਟ ਨੂੰ ਮਾਈਗ੍ਰੇਸ਼ਨ ਚੈੱਕਲਿਸਟ ਪੇਜ਼ ਦੇ ਉਪਰ ਰੱਖੋ ਤਾਂ ਕਿ ਇਹ ਡਿਫਾਲਟ ਸ਼ੁਰੂਆਤ ਬਣ ਜਾਵੇ।
ਟਾਈਮਲਾਈਨ ਜਾਂ ਮਾਈਲਸਟੋਨ ਵਿਊ: ਕਈ ਪਾਠਕ ਯੋਜਨਾ ਬਣਾਉਣ ਲਈ ਮਾਰਗ ਦਿਖਾਉਂਦੇ ਹਨ। ਇੱਕ ਹਲਕਾ-ਫੁਲਕਾ "ਮਾਈਲਸਟੋਨ" ਬਲੌਕ ਜੋੜੋ ਜੋ ਕੰਮਾਂ ਨੂੰ ਫੇਜ਼ਾਂ ਅਨੁਸਾਰ ਗਰੁੱਪ ਕਰੇ। ਸਧਾਰਨ ਰੱਖੋ: ਹਰ ਮਾਈਲਸਟੋਨ ਲਈ ਇੱਕ ਲਾਈਨ, ਅਨੁਮਾਨਿਤ ਕੋਸ਼ਿਸ਼ ਰੇਂਜ ਅਤੇ ਡਿਪੈਂਡੇੰਸੀਜ਼।
ਫੈਸਲਾ ਮਦਦਗਾਰ ਪ੍ਰਸ਼ਨਾਵਲੀ: ਇੱਕ ਛੋਟੀ, ਗੈਰ-ਟੈਕਨੀਕਲ ਪ੍ਰਸ਼ਨਾਵਲੀ (5–8 ਸਵਾਲ) ਇੱਕ ਮਾਈਗ੍ਰੇਸ਼ਨ ਪਾਥ ਦੀ ਸਿਫਾਰਸ਼ ਕਰ ਸਕਦੀ ਹੈ (lift-and-shift vs re-platform vs phased)। ਨਤੀਜਿਆਂ ਨੂੰ ਵਜਹ ਸਮਝਾਓ: ਕਿਉਂ ਸਜ਼ੇਸ਼ਨ ਆਇਆ ਅਤੇ ਸਬੰਧਤ ਪਾਥ ਪੰਨੇ ਦੀ ਲਿੰਕ ਦਿਓ।
ਤਸਦੀਕ ਫਾਰਮ: "ਮੁੱਕ ਗਿਆ" ਨੂੰ ਨਿਰੀਖਣਯੋਗ ਚੈੱਕ ਬਣਾਓ। ਬੇਸਲਾਈਨ ਅਤੇ ਬਾਅਦ ਮੁੱਲਾਂ ਲਈ ਫ਼ਿਲ-ਇਨ ਫੀਲਡ ਦਿਓ (ਰਿਸਪਾਂਸ ਸਮਾਂ, ਐਰਰ ਦਰ, ਯੂਜ਼ਰ ਸਾਈਨ-ਇਨ, ਡੇਟਾ ਰਿਕਨਸਿਲੀਏਸ਼ਨ ਗਿਣਤੀਆਂ)। ਪੜ੍ਹਨ ਵਾਲਾ ਇਹ ਨਤੀਜੇ ਆਪਣੀਆਂ ਅੰਦਰੂਨੀ ਸਥਿਤੀ ਰਿਪੋਰਟਾਂ ਵਿੱਖੇ ਪੇਸਟ ਕਰ ਸਕਦਾ ਹੈ।
ਟ੍ਰਬਲਸ਼ੂਟਿੰਗ ਫਿਲਟਰ: ਲੰਬੇ FAQ ਦੀ ਥਾਂ, ਪੜ੍ਹਨ ਵਾਲੇ ਨੂੰ ਲੱਛਣ ਮੁਤਾਬਕ ਫਿਲਟਰ ਕਰਨ ਦਿਓ (ਉਦਾਹਰਨ: "login failures"), ਫੇਜ਼ ("cutover"), ਜਾਂ ਕੰਪੋਨੈਂਟ ("database") ਦੇ ਅਧਾਰ 'ਤੇ। ਫਿਲਟਰ ਸਥਿਰ ਅਤੇ ਤੇਜ਼ ਰੱਖੋ—ਕੋਈ ਜਟਿਲ ਬੈਕਐਂਡ ਦੀ ਲੋੜ ਨਹੀਂ।
ਜੇ ਤੁਹਾਨੂੰ ਕਿਸੇ ਇੰਟਰਐਕਸ਼ਨ ਨੂੰ ਸ਼ਾਮਿਲ ਕਰਨ ਵਿੱਚ ਨਿਹਾਇਤੀ ਸੰਦੇਹ ਹੈ, ਇੱਕ ਨਿਯਮ ਵਰਤੋਂ: ਇਹ ਕੋਈ ਅਸਲ ਮਾਈਗ੍ਰੇਸ਼ਨ ਕਾਲ 'ਤੇ ਸਮਾਂ ਬਚਾਉਣਾ ਚਾਹੀਦਾ ਹੈ।
ਸਭ ਤੋਂ ਵਧੀਆ ਮਾਈਗ੍ਰੇਸ਼ਨ ਗਾਈਡ ਸਾਈਟ ਪਾਠਕਾਂ ਲਈ ਸਧਾਰਣ ਮਹਿਸੂਸ ਕਰਦੀ ਹੈ ਕਿਉਂਕਿ ਆਧਾਰਕ ਚੋਣਾਂ ਸਪੱਸ਼ਟ ਹੁੰਦੀਆਂ ਹਨ: ਸਮੱਗਰੀ ਕਿੱਥੇ ਰਹੇਗੀ, ਇਹ ਕਿਵੇਂ ਪ੍ਰਕਾਸ਼ਿਤ ਹੋਵੇਗੀ, ਅਤੇ ਕੌਣ ਇਸਦੀ ਦੇਖਭਾਲ ਕਰੇਗਾ।
Static site generator (SSG) (ਉਦਾਹਰਨ: ਸਮੱਗਰੀ Markdown ਵਿੱਚ, ਸਾਈਟ HTML ਵਿੱਚ ਬਿਲਡ ਹੋਵੇ)।
ਡੈਡੀਕੇਟਿਡ ਡੌਕਸ ਪਲੇਟਫਾਰਮ (ਹੋਸਟਡ ਡੌਕਯੂਮੈਂਟੇਸ਼ਨ ਟੂਲ)।
CMS (ਜਿਵੇਂ WordPress ਜਾਂ headless CMS)।
ਇੱਕ ਵਰਤਮਾਨ ਨਿਯਮ: ਜੇ ਤੁਹਾਡੀ ਗਾਈਡ ਅਕਸਰ ਬਦਲੇਗੀ ਅਤੇ ਕਈ ਲੋਕ ਇਸ ਨੂੰ ਸੰਪਾਦਿਤ ਕਰਨਗੇ, ਤਾਂ docs ਪਲੇਟਫਾਰਮ ਜਾਂ CMS ਆਮ ਤੌਰ 'ਤੇ ਘੱਟ ਅੜਚਣ ਪੈਦਾ ਕਰਦਾ ਹੈ। ਜੇ ਤੁਸੀਂ ਇੱਕ ਹلਕਾ-ਫੁਲਕਾ, ਵੱਧ ਵਰਜ਼ਨਯੋਗ ਗਾਈਡ ਚਾਹੁੰਦੇ ਹੋ, ਤਾਂ SSG ਅਕਸਰ ਆਰਥਿਕ ਹੁੰਦਾ ਹੈ।
ਜੇ ਤੁਸੀਂ ਰਵਾਇਤੀ "spec → build → iterate" ਸਾਈਕਲ ਤੋਂ ਤੇਜ਼ ਚਲਨਾ ਚਾਹੁੰਦੇ ਹੋ, ਤਾਂ vibe-coding ਪਲੇਟਫਾਰਮ ਜਿਵੇਂ Koder.ai ਇੰਟਰਐਕਟਿਵ ਹਿੱਸਿਆਂ ਲਈ ਵਾਜਿਬ ਵਿਕਲਪ ਹੋ ਸਕਦਾ ਹੈ। ਟੀਮਾਂ ਇਸਦੀ ਵਰਤੋਂ ਉਦਾਹਰਨ ਵਜੋਂ ਕਰਦੀਆਂ ਹਨ:
Koder.ai ਚੈਟ ਰਾਹੀਂ ਵੈੱਬ ਐਪ ਜੈਨਰੇਟ ਕਰ ਸਕਦਾ ਹੈ (React ਫਰੰਟਏਂਡ ਅਤੇ ਜ਼ਰੂਰਤ ਹੋਣ ਤੇ Go + PostgreSQL ਬੈਕਏਂਡ), ਇਸ ਲਈ ਜਦੋਂ ਤੁਹਾਡੀ ਗਾਈਡ ਨੂੰ ਹਲਕਾ ਟੂਲ ਚਾਹੀਦਾ ਹੈ—ਤਾਂ ਬਿਨਾਂ ਲੰਬੇ ਕਸਟਮ ਵਿਕਾਸ ਪ੍ਰੋਸੈਸ ਦੇ ਤੁਸੀਂ ਤੇਜ਼ੀ ਨਾਲ ਪ੍ਰੋਟੋਟਾਈਪ ਕਰ ਸਕਦੇ ਹੋ। ਤੁਸੀਂ ਲੰਬੇ ਸਮੇਂ ਦੀ ਦੇਖਭਾਲ ਲਈ ਸੋурс ਕੋਡ ਵੀ ਐਕਸਪੋਰਟ ਕਰ ਸਕਦੇ ਹੋ।
SSG ਲਈ, CDN/static hosting ਸਭ ਤੋਂ ਸਧਾਰਨ ਹੈ: ਤੁਸੀਂ pre-built ਫਾਈਲ ਪਬਲਿਸ਼ ਕਰਦੇ ਹੋ ਅਤੇ CDN ਉਨ੍ਹਾਂ ਨੂੰ ਤੇਜ਼ੀ ਨਾਲ ਸਰਵ ਕਰਦਾ ਹੈ। CMS ਜਾਂ ਡਾਇਨਾਮਿਕ ਡੌਕਸ ਟੂਲ ਲਈ, ਤੁਸੀਂ ਸਰਵਰ ਹੋਸਟਿੰਗ ਵਰਤੋਗੇ (managed hosting ਆਮ ਤੌਰ 'ਤੇ ਵਧੀਆ ਰਹਿੰਦੀ ਹੈ)।
ਡਿਪਲੌਇਮੈਂਟ ਪ੍ਰਕਿਰਿਆ ਭਵਿੱਖਵਾਣੀਯੋਗ ਰੱਖੋ: ਇੱਕ ਬਟਨ ਜਾਂ ਇੱਕ ਪਾਈਪਲਾਈਨ ਜੋ ਬਿਲਡ ਅਤੇ ਪ੍ਰਕਾਸ਼ਿਤ ਕਰਦਾ ਹੋਵੇ। ਜੇ ਸੰਭਵ ਹੋਵੇ, ਹਰ ਬਦਲਾਅ ਲਈ ਪ੍ਰੀਵਿਊ ਸੈਟ ਕਰੋ ਤਾਂ ਕਿ ਸਮੀਖਿਆਕਾਰ ਅਪਡੇਟ ਪਬਲਿਕ ਹੋਣ ਤੋਂ ਪਹਿਲਾਂ ਪੜ੍ਹ ਸਕਣ।
ਤਿੰਨ ਪੜਾਵਾਂ ਪਰਿਭਾਸ਼ਿਤ ਕਰੋ ਅਤੇ ਓਹਨਾਂ ਨੂੰFollow ਕਰੋ:
ਜੇ ਕੁਝ ਸਮੱਗਰੀ ਗੋਪਨীয় ਹੋਣੀ ਚਾਹੀਦੀ ਹੈ (ਅੰਦਰੂਨੀ ਰਨਬੁੱਕ, ਵੈਂਡਰ Credentials, ਜਾਂ ਗ੍ਰਾਹਕ-ਖਾਸ ਕਦਮ), ਤਾਂ ਸ਼ੁਰੂ ਵਿੱਚ ਹੀ ਐਕਸੈਸ ਕੰਟਰੋਲ ਯੋਜਨਾ ਬਣਾਓ: "ਪਬਲਿਕ" ਅਤੇ "ਪ੍ਰਾਈਵੇਟ" ਖੇਤਰਾਂ ਨੂੰ ਅਲੱਗ ਰੱਖੋ, ਜਾਂ ਦੂਜੀ ਅੰਦਰੂਨੀ ਸਾਈਟ ਪ੍ਰਕਾਸ਼ਤ ਕਰੋ।
ਅੰਤ ਵਿੱਚ, ਡੌਕਯੂਮੈਂਟੇਸ਼ਨ ਮਲਕੀਅਤ ਨਿਯੁਕਤ ਕਰੋ (ਇੱਕ ਪ੍ਰਾਇਮਰੀ ਮਾਲਕ + ਬੈਕਅੱਪ) ਅਤੇ ਇੱਕ ਅਪਡੇਟ ਕੈਡੈਂਸ ਦੇਵੋ (ਉਦਾਹਰਨ: ਮਾਈਗ੍ਰੇਸ਼ਨ ਦੌਰਾਨ ਮਹੀਨਾਵਾਰ, ਬਾਅਦ ਵਿੱਚ ਤਿਮਾਹੀ)। ਨਾਮ ਨਾਲ ਨਿਰਧਾਰਤ ਮਾਲਕਾਂ ਤੋਂ ਬਿਨਾਂ, ਡੌਕਸ ਜਲਦੀ ਪੁਰਾਣੇ ਹੋ ਜਾਂਦੇ ਹਨ।
ਮਾਈਗ੍ਰੇਸ਼ਨ ਗਾਈਡ ਲਈ SEO ਜਨਰਲ ਟ੍ਰੈਫਿਕ ਦੀ ਤਲਾਸ਼ ਨਹੀਂ ਹੈ—ਇਹ ਉਸ ਸਮੇਂ ਲੱਭਣਯੋਗ ਹੋਣਾ ਹੈ ਜਦੋਂ ਕੋਈ ਕਿਸੇ ਮੂਵ ਦੀ ਯੋਜਨਾ ਬਣਾਉਂਦਾ ਹੈ ਜਾਂ ਕਿਸੇ ਸਮੱਸਿਆ ਵਿੱਚ ਫੱਸ ਗਿਆ ਹੈ। "migration intent" ਖੋਜਾਂ ਲਈ ਨਿਸ਼ਾਨਾ ਬਣਾ ਕੇ ਹਰ ਪੰਨੇ ਨੂੰ ਇੱਕ ਸਪਸ਼ਟ ਕਦਮ ਦਾ ਜਵਾਬ ਬਣਾਓ।
ਇੱਕ ਸੂਚੀ ਬਣਾਓ ਜਿਹੜੀ ਸੋਰਸ, ਟਾਰਗਟ, ਅਤੇ ਕੰਮ ਸ਼ਾਮਿਲ ਕਰਦੀ ਹੋਵੇ। ਉਦਾਹਰਨ:
ਇਨ੍ਹਾਂ ਫਰੇਜ਼ਾਂ ਨੂੰ ਵਰਤ ਕੇ ਤੈਅ ਕਰੋ ਕਿ ਤੁਹਾਨੂੰ ਕਿਹੜੇ ਪੰਨੇ ਲੋੜੀਦੇ ਹਨ (ਪੂਰਵ-ਸ਼ਰਤ, ਕਦਮ-ਦਰ-ਕਦਮ ਟਾਸਕ, ਵੈਰੀਫਿਕੇਸ਼ਨ, ਰੋਲਬੈਕ, ਆਮ ਗਲਤੀਆਂ)।
ਲੋਕ ਖੋਜ ਨਤੀਜਿਆਂ ਨੂੰ ਸਕੈਨ ਕਰਦੇ ਹਨ। ਆਪਣੇ ਪੇਜ਼ ਦੇ ਸਿਰਲੇਖ (Title) ਅਤੇ H1 ਨੂੰ ਸਪਸ਼ਟ ਅਤੇ ਸਟੈਪ ਨਾਂ ਨਾਲ ਮਿਲਾਵੋ।
ਚੰਗਾ: “Step 3: Migrate Users from X to Y”
ਟਾਲੋ: “User Setup” (ਇਹ ਰੈਂਕ ਨਹੀਂ ਕਰੇਗਾ, ਅਤੇ ਨਿਰਾਸ਼ਾ ਪੈਦਾ ਕਰੇਗਾ)।
ਅੰਦਰੂਨੀ ਲਿੰਕ ਪੜ੍ਹਨ ਵਾਲਿਆਂ ਨੂੰ ਰਾਹ ਦਿਖਾਉਂਦੇ ਹਨ ਅਤੇ ਸਿਰਚ ਇੰਜਣਾਂ ਨੂੰ ਸੰਰਚਨਾ ਸਮਝਣ ਵਿੱਚ ਮਦਦ ਕਰਦੇ ਹਨ।
ਲਿੰਕ ਕਰੋ:
/troubleshooting/error-403) ਤੋਂਲਿੰਕ ਪ੍ਰਭਾਵੀ ਅਤੇ ਉਨ੍ਹਾਂ ਥਾਵਾਂ ਦੇ ਨੇੜੇ ਰੱਖੋ ਜਿਵੇਂ ਕਿ ਪੜ੍ਹਨ ਵਾਲੇ ਨੂੰ ਲੋੜ ਹੋਵੇ।
ਪਠਨਯੋਗ URLs ਵਰਤੋਂ ਜੋ ਸਟੈਪ ਨਾਮ ਨਾਲ ਮਿਲਦੇ ਹੋਣ, ਜਿਵੇਂ:
/checklist/steps/migrate-users/troubleshooting/permission-errorsਸੰਖੇਪ meta descriptions ਲਿਖੋ ਜੋ ਦੱਸਣ ਕਿ ਪੇਜ਼ ਕਿਸ ਲਈ ਹੈ, ਕੀ ਕਰਦਾ ਹੈ, ਅਤੇ ਨਤੀਜਾ (ਇੱਕ-ਵਾਕ ਵਾਅਦਾ)।
Glossary ਗੈਰ-ਟੈਕਨੀਕਲ ਪਾਠਕਾਂ ਦੀ ਮਦਦ ਕਰਦਾ ਹੈ ਅਤੇ "what is a migration token" ਜਾਂ "data mapping definition" ਵਰਗੀਆਂ ਖੋਜਾਂ ਨੂੰ ਕੈਚ ਕਰਦਾ ਹੈ। /glossary 'ਤੇ ਸਹੀ-ਸਮਝ ਪਰਿਭਾਸ਼ਾਵਾਂ ਰੱਖੋ ਅਤੇ ਸਟੇਪਾਂ ਤੋਂ ਲਿੰਕ ਕਰੋ।
ਇੱਕ ਮਾਈਗ੍ਰੇਸ਼ਨ ਗਾਈਡ ਉਸ ਵੇਲੇ ਲਾਭਦਾਇਕ ਰਹਿੰਦੀ ਹੈ ਜਦੋਂ ਤੁਸੀਂ ਦੇਖਦੇ ਹੋ ਕਿ ਲੋਕ ਕੀ ਕਰ ਰਹੇ ਹਨ, ਫਿਰ ਉਹਨਾਂ ਰੁਕਾਵਟਾਂ ਨੂੰ ਦੂਰ ਕਰਦੇ ਹੋ।
ਇਕ ਛੋਟੀ ਘੱਟ-ਸੈਟਕਾਰੀਆਂ ਸਟਾਰਟ ਕਰੋ ਜੋ ਪੜ੍ਹਨ ਵਾਲੇ ਮਨਸ਼ਾ ਨਾਲ ਜੁੜੀਆਂ ਹੋਣ। ਕਾਰਜਕਾਰੀ ਸੰਕੇਤ:
ਇਵੈਂਟਾਂ ਨੂੰ ਪੇਜ਼ਾਂ 'ਤੇ ਇਕਸਾਰ ਰੱਖੋ ਤਾਂ ਤੁਸੀਂ ਵੱਖ-ਵੱਖ ਭਾਗਾਂ ਦੀ ਤੁਲਨਾ ਕਰ ਸਕੋ ਅਤੇ ਰੁਝਾਨ ਪਛਾਣ ਸਕੋ (ਉਦਾਹਰਨ: "Data export" ਪੰਨੇ ਸਭ ਤੋਂ ਜ਼ਿਆਦਾ ਐਗਜ਼ਿਟ ਲੈਂਦੇ ਹਨ)।
ਲੋਕ ਤਦ ਹੀ ਫੀਡਬੈਕ ਦਿੰਦੇ ਹਨ ਜਦੋਂ ਇਹ ਤੇਜ਼ ਅਤੇ ਸਵਾਗਤਯੋਗ ਹੋਵੇ।
/support ਪੇਜ਼ 'ਤੇ ਲਿੰਕ ਕਰੋ।ਇੱਕ ਸਧਾਰਨ ਟ੍ਰਿਆਜ ਨੀਤੀ ਬਣਾਓ: ਜੋ ਕੁਝ ਪ੍ਰਗਟ ਰੂਪ ਵਿੱਚ ਪ੍ਰਗਟੀ ਰੁਕਾਵਟ ਪੈਦਾ ਕਰਦਾ ਹੈ (ਗਲਤ ਕਦਮ ਕ੍ਰਮ, ਗੁੰਮ ਪਮਿਸ਼ਨ, ਫੇਲ ਹੁੰਦੀਆਂ ਕਮਾਂਡ) ਪਹਿਲਾਂ ਠੀਕ ਕਰੋ। ਫਿਰ ਉਹ ਸੈਕਸ਼ਨਾਂ ਦੁਬਾਰਾ ਲਿਖੋ ਜਿੱਥੇ ਐਨਾਲਿਟਿਕਸ ਵਾਪਸੀ ਦਰਸਾਉਂਦੇ ਹਨ, ਅਤੇ ਵਧੇਰੇ ਉਦਾਹਰਨ ਜਾਂ "Common mistakes" ਛੋਟਾ ਸੈਕਸ਼ਨ ਜੋੜੋ।
ਫੀਡਬੈਕ ਵਾਲਿਊਮ ਅਤੇ ਪ੍ਰੋਡਕਟ ਬਦਲਾਵਾਂ ਦੇ ਆਧਾਰ 'ਤੇ ਸਮੀਖਿਆ ਕੈਡੈਂਸ ਤੈਅ ਕਰੋ। ਇੱਕ ਬੇਸਲਾਈਨ ਵਜੋਂ, ਉੱਚ-ਟਰੈਫਿਕ ਪੰਨਿਆਂ ਦੀ ਮਹੀਨਾਵਾਰ ਸਮੀਖਿਆ ਅਤੇ ਪੂਰੇ ਡੌਕਸ ਸਾਈਟ ਦੀ ਤਿਮਾਹੀ ਸਮੀਖਿਆ ਕਰੋ। ਰਿਲੀਜ਼ ਨੋਟਸ ਨਾਲ ਸਮੀਖਿਆ ਜੋੜਨ ਨਾਲ ਗਾਈਡ ਉਤਪਾਦ ਵਿੱਚ ਹੋ ਰਹੀਆਂ ਬਦਲਾਵਾਂ ਨਾਲ ਸੰਗਤ ਰਹੇਗੀ।
ਮਾਈਗ੍ਰੇਸ਼ਨ ਗਾਈਡ ਤਦ ਹੀ ਲਾਭਦਾਇਕ ਰਹਿੰਦੀ ਹੈ ਜਦੋਂ ਇਹ ਉਹ ਉਤਪਾਦ ਜੋ ਲੋਕ ਮਾਈਗ੍ਰੇਟ ਕਰ ਰਹੇ ਹਨ, ਨਾਲ ਮੇਲ ਖਾਂਦੀ ਰਹੇ। ਵਰਜ਼ਨਿੰਗ ਅਤੇ ਨਿਬੜੀ-ਸੰਭਾਲ "ਬਾਅਦ" ਵੱਲ ਮੋਦੀ ਜਾਣ ਵਾਲੇ ਕੰਮ ਨਹੀਂ—ਇਹ ਉਹ ਹਨ ਜੋ ਗਾਈਡ ਨੂੰ ਭਰੋਸੇਯੋਗ ਰੱਖਦੇ ਹਨ ਅਤੇ ਸਟੇਕਹੋਲਡਰਾਂ ਵੱਲੋਂ ਸਾਂਝੇ ਕੀਤੇ ਪੰਨਿਆਂ ਕਰਕੇ ਬਣੌਕੀਆਂ ਘਟਾਉਂਦੇ ਹਨ।
ਜੇ ਤੁਹਾਡੇ ਸਾਫਟਵੇਅਰ ਦੇ ਕਈ ਸਮਰਥਿਤ ਵਰਜ਼ਨ ਹਨ, ਤਾਂ ਹਰ ਸੰਬੰਧਤ ਪੰਨੇ 'ਤੇ ਵਰਜ਼ਨ ਸਿਲੈਕਟਰ ਜਾਂ ਬਹੁਤ ਸਪਸ਼ਟ ਵਰਜ਼ਨ ਲੇਬਲ ਸ਼ਾਮਿਲ ਕਰੋ (ਉਦਾਹਰਨ: "Source: v3.2 → Target: v4.0"). ਇਹ ਜਾਣਕਾਰੀ ਇੰਟਰੋ ਪੈਰਾ ਵਿੱਚ ਛੁਪਾਉਣ ਦੀ ਬਜਾਏ ਸਿਰਲੇਖ ਨੇੜੇ ਪ੍ਰਮੁੱਖ ਹੋਣੀ ਚਾਹੀਦੀ ਹੈ—ਕਿਉਂਕਿ ਪੜ੍ਹਨ ਵਾਲੇ ਆਮ ਤੌਰ 'ਤੇ ਖੋਜ ਤੋਂ ਡੈੱਪ ਲੇਵਲ ਪੰਨਿਆਂ 'ਤੇ ਲੈਂਡ ਕਰਦੇ ਹਨ।
ਜੇ ਤੁਸੀਂ ਸਿਲੈਕਟਰ ਨਹੀਂ ਲਗਾ ਸਕਦੇ, ਤਾਂ ਸਿਰਲੇਖ ਨੇੜੇ ਅਤੇ ਕਾਲਆਉਟ ਨੋਟਾਂ ਵਿੱਚ ਸਪਸ਼ਟ ਲੇਬਲ ਵਰਤੋ ਜਿਵੇਂ "Applies to v4.0+"। ਲਗਾਤਾਰਤਾ ਫੈਂਸੀ UI ਨਾਲੋਂ ਵੱਧ ਜ਼ਰੂਰੀ ਹੈ।
ਅਪਡੇਟ ਕਿਵੇਂ ਹੁੰਦੇ ਹਨ ਅਤੇ ਕੌਣ ਜਿੰਮੇਵਾਰ ਹੈ, ਇਹ ਪਰਿਭਾਸ਼ਿਤ ਕਰੋ ਅਤੇ ਬਦਲਾਵਾਂ ਨੂੰ ਉਤਪਾਦ ਰਿਲੀਜ਼ਾਂ ਅਤੇ ਮਾਈਗ੍ਰੇਸ਼ਨ ਟੂਲਿੰਗ ਅੱਪਡੇਟ ਨਾਲ ਜੋੜੋ। "ਹਫਤਾਵਾਰ ਅਪਡੇਟ" ਵਰਗੇ ਵਾਅਦੇ ਕਰਨ ਤੋਂ ਬਚੋ; ਬਜਾਏ ਇੱਕ ਭਰੋਸੇਯੋਗ ਨੀਤੀ ਦਿਓ, ਉਦਾਹਰਨ:
ਇਹ ਨੀਤੀ ਇੱਕ ਛੋਟੇ "About this guide" ਪੰਨੇ (/migration-guide/about) 'ਤੇ ਪ੍ਰਕਾਸ਼ਿਤ ਕਰੋ ਤਾਂ ਉਮੀਦਾਂ ਸਪਸ਼ਟ ਰਹਿਣ।
ਡੌਕਸ ਅਪਡੇਟ ਅਤੇ ਮਾਈਗ੍ਰੇਸ਼ਨ ਟੂਲਿੰਗ ਬਦਲਾਵਾਂ ਲਈ ਇੱਕ ਚੇਂਜਲੌਗ ਰੱਖੋ। ਉਹ ਸੰਞੇਪ ਅਤੇ ਕਾਰਜਕਾਰੀ ਹੋਵੇ: ਕੀ ਬਦਲਿਆ, ਕਿਨ੍ਹਾਂ ਨੂੰ ਪ੍ਰਭਾਵਤ ਕਰਦਾ, ਅਤੇ ਤਾਰੀਖ।
ਜਦੋਂ ਕਾਰਜਵਿਧੀਆਂ ਪੁਰਾਣੀਆਂ ਹੋ ਜਾਂਦੀਆਂ ਹਨ, ਉਨ੍ਹਾਂ ਨੂੰ ਮਿਟਾਉਣ ਦੇ ਬਦਲੇ ਆਰਕਾਈਵ ਕਰੋ। ਉਨ੍ਹਾਂ 'ਤੇ "Archived" ਲੇਬਲ ਲਗਾਓ ਅਤੇ ਦੱਸੋ ਕੀ ਬਦਲਾਇਆ ਗਿਆ। ਸਭ ਤੋਂ ਮਹੱਤਵਪੂਰਨ, ਪੁਰਾਣੇ URLs ਤੋਂ ਨਵੇਂ ਸਥਾਨਾਂ ਲਈ ਰੀਡਾਇਰੈਕਟ ਰੱਖੋ ਤਾਂ ਕਿ ਟਿਕਟਾਂ, ਈਮੇਲਾਂ, ਜਾਂ ਬੁੱਕਮਾਰਕਾਂ ਵਿਚ ਸਾਂਝੇ ਕੀਤੇ ਪੰਨੇ ਟੁੱਟਣ ਨਾ ਪਾਣ।
ਪਬਲਿਸ਼ ਕਰਨ ਤੋਂ ਪਹਿਲਾਂ ਸਧਾਰਨ ਸਮੱਗਰੀ QA ਸੈੱਟ ਕਰੋ:
ਇਹ ਜਾਂਚਾਂ ਨਿਰੰਤਰ ਬਗ਼ੈਰ ਅਨੁਸ਼ਾਸਨ ਦੇ ਬਦਲਾਅ ਰੋਕਣਗੀਆਂ ਅਤੇ ਲੰਬੇ ਸਮੇਂ ਦੀ ਸਾਂਭ ਸੰਭਾਲ ਯੋਗ ਬਣਾਉਂਦੀਆਂ ਹਨ।
ਮਾਈਗ੍ਰੇਸ਼ਨ ਗਾਈਡ ਬਾਰ-ਬਾਰ ਦਬਾਅ ਹੇਠਾਂ ਵਰਤੀ ਜਾਂਦੀ ਹੈ: ਕਟਓਵਰ ਦੌਰਾਨ, ਘਟਨਾ ਸੰਭਾਲ, ਅਤੇ ਰਾਤ ਦੇ ਵੇਲੇ ਤਸਦੀਕ। ਇਹੇ ਸਮੇਂ ਹਨ ਜਦੋਂ ਛੋਟੀਆਂ "ਬੁਨਿਆਦੀ" ਚੀਜ਼ਾਂ (ਪਹੁੰਚਯੋਗਤਾ, ਸੁਰੱਖਿਆ, ਕੰਪਲਾਇੰਸ) ਅਸਲ ਰੁਕਾਵਟਾਂ ਨੂੰ ਰੋਕਦੇ ਹਨ—ਜਿਵੇਂ ਕਿ ਕੋਈ ਸਾਈਟ ਨੂੰ ਕੀਬੋਰਡ ਨਾਲ ਨਹੀ ਚਲਾ ਸਕਦਾ, ਜਾਂ ਇੱਕ ਉਦਾਹਰਣ ਵਿੱਚ ਗਲਤ ਤਰੀਕੇ ਦੀ ਕ੍ਰੈਡੇਨਸ਼ਲ ਪੈਟਰਨ ਦਿੱਤੀ ਹੋਵੇ।
ਹਰ ਪੰਨੇ ਟੈਮਪਲੇਟ 'ਤੇ ਲਾਗੂ ਹੋਣ ਵਾਲੀਆਂ ਮੂਢੀ ਨੀਤੀਆਂ ਨਾਲ ਸ਼ੁਰੂ ਕਰੋ:
ਜੇ ਤੁਸੀਂ ਡਾਇਗ੍ਰਾਮ ਅਜਿਹਾ ਪ੍ਰਕਾਸ਼ਤ ਕਰਦੇ ਹੋ ਜਿਸ ਵਿੱਚ ਮੁੱਖ ਜਾਣਕਾਰੀ ਹੈ, ਤਾਂ ਉਹਨਾਂ ਦੇ ਹੇਠਾਂ ਛੋਟਾ ਟੈਕਸਟ ਖੁਲਾਸਾ ਦਿਓ। ਇਹ ਪਹੁੰਚਯੋਗਤਾ ਵਿੱਚ ਮਦਦ ਕਰਦਾ ਹੈ ਅਤੇ ਨਾਨ-ਟੈਕਨੀਕਲ ਪਾਠਕਾਂ ਲਈ ਤੇਜ਼ੀ ਨਾਲ ਸਰੋਤ ਕਰਨਯੋਗ ਬਣਾਉਂਦਾ ਹੈ।
ਮਾਈਗ੍ਰੇਸ਼ਨ ਡੌਕਸ ਅਕਸਰ config, CLI ਕਮਾਂਡ, ਅਤੇ ਨਮੂਨਾ ਡੇਟਾ ਸ਼ਾਮਿਲ ਕਰਦੀਆਂ ਹਨ। ਸਭ ਉਦਾਹਰਣਾਂ ਨੂੰ ਏਸ ਤਰ੍ਹਾਂ ਮੰਨੋ ਕਿ ਉਹ ਪ੍ਰੋਡਕਸ਼ਨ ਵਿੱਚ ਨਕਲ ਕੀਤੇ ਜਾ ਸਕਣ:
REDACTED_TOKEN, example.company, 10.0.0.0/24)।ਜਿੱਥੇ ਕਦਮ ਖਤਰਾ ਪੈਦਾ ਕਰ ਸਕਦਾ ਹੈ, ਉਥੇ "security notes" ਜੋੜੋ: ਟੂਲ ਚਲਾਉਣ ਲਈ ਲੋੜੀਂਦੇ ਪਰਮਿਸ਼ਨ, ਸੁਰੱਖਿਅਤ ਕ੍ਰੈਡੇਨਸ਼ਲ ਹੈਂਡਲਿੰਗ (env vars, secret managers), ਅਤੇ ਚਲਾਉਣ ਬਾਅਦ ਡਿਟ ਲੌਗਾਂ ਵਿੱਚ ਕੀ ਚੈੱਕ ਕਰਨਾ ਹੈ।
ਜੇ ਤੁਹਾਡੇ ਪਾਠਕ ਨਿਯਮਤ ਵਾਤਾਵਰਣਾਂ ਵਿੱਚ ਕੰਮ ਕਰਦੇ ਹਨ, ਤਾਂ ਸਬੰਧਤ ਪੰਨਾਂ 'ਤੇ ਸੰਞੇਪ ਕੰਪਲਾਇੰਸ ਨੋਟ ਸ਼ਾਮਿਲ ਕਰੋ:
ਕੁਝ ਟੀਮਾਂ ਨੂੰ ਚੇਂਜ ਰਿਕਵੇਸਟ ਨਾਲ ਯੋਜਨਾਵਾਂ ਜੁੜੀਆਂ ਹੋਣੀਆਂ ਪੈਂਦੀਆਂ ਹਨ। ਪ੍ਰਿੰਟੇਬਲ/ਐਕਸਪੋਰਟ ਯੂਜੇਬਲ ਫਾਰਮੈਟ (PDF, ਪ੍ਰਿੰਟ-ਫ੍ਰੈਂਡਲੀ ਪੰਨੇ, ਜਾਂ "download checklist" ਦ੍ਰਿਸ਼) ਦੇ ਵਿਕਲਪ ਦਿਓ। ਚੈੱਕਲਿਸਟਾਂ ਲਈ ਇੱਕ समर्पਿਤ /migration-checklist ਪੇਜ਼ ਵਿਚਾਰ ਕਰੋ ਜੋ ਸਾਫ਼ ਪ੍ਰਿੰਟ ਹੋਵੇ ਅਤੇ ਇੰਟਰਐਕਟਿਵ-ਓਨਲੀ UI 'ਤੇ ਨਿਰਭਰ ਨਾ ਹੋਵੇ।