Architecture Decision Record

Active theme: Light

← ਫੈਸਲਾ ਰਿਕਾਰਡ ਟੈਂਪਲੇਟ

ਆਰਕੀਟੈਕਚਰ ਫੈਸਲਾ ਰਿਕਾਰਡ (ADR) ਟੈਂਪਲੇਟ

ਇਹ EdgeX Foundry ADR ਲਈ ਇੱਕ ਟੈਂਪਲੇਟ ਹੈ।

ਸਰੋਤ: https://docs.edgexfoundry.org/2.3/design/adr/template/

ਪੇਸ਼ਕਰਤਾ

ADR ਪੇਸ਼ ਕਰਨ ਵਾਲਿਆਂ ਦੀ ਸੂਚੀ ਦਿਓ।

ਫਾਰਮੈਟ:

  • ਨਾਮ (ਸੰਸਥਾ)

ਤਬਦੀਲੀ ਲੌਗ

ਦਸਤਾਵੇਜ਼ ਵਿੱਚ ਹੋਈਆਂ ਤਬਦੀਲੀਆਂ ਦੀ ਸੂਚੀ ਦਿਓ, ਜਿਨ੍ਹਾਂ ਵਿੱਚ ਅਵਸਥਾ, ਮਿਤੀ ਅਤੇ PR URL ਸ਼ਾਮਲ ਹੋਣ।

ਅਵਸਥਾ ਇਨ੍ਹਾਂ ਵਿੱਚੋਂ ਇੱਕ ਹੈ: ਲੰਬਿਤ (pending), ਮਨਜ਼ੂਰ (approved), ਸੋਧਿਆ (amended), ਅਪ੍ਰਚਲਿਤ (deprecated)।

ਮਿਤੀ ਇੱਕ ISO 8601 (YYYY-MM-DD) ਸਟਰਿੰਗ ਹੈ।

PR ਉਹ ਪੁੱਲ ਰਿਕੁਐਸਟ ਹੈ ਜਿਸ ਨੇ ਤਬਦੀਲੀ ਪੇਸ਼ ਕੀਤੀ, ਜਿਸ ਵਿੱਚ ਅੰਤਰ (diff), ਯੋਗਦਾਨ ਪਾਉਣ ਵਾਲੇ ਅਤੇ ਸਮੀਖਿਅਕਾਂ ਵਰਗੀ ਜਾਣਕਾਰੀ ਸ਼ਾਮਲ ਹੁੰਦੀ ਹੈ।

ਫਾਰਮੈਟ:

  • [ADR ਦੀ ਅਵਸਥਾ, ਜਿਵੇਂ ਕਿ approved, amended, ਆਦਿ](ਪੁੱਲ ਰਿਕੁਐਸਟ ਦਾ URL) YYYY-MM-DD

ਹਵਾਲਾ ਦਿੱਤੇ ਵਰਤੋਂ ਦੇ ਕੇਸ

ਸਾਰੇ ਸੰਬੰਧਿਤ ਵਰਤੋਂ ਦੇ ਕੇਸ / ਲੋੜਾਂ ਦੇ ਦਸਤਾਵੇਜ਼ਾਂ ਦੀ ਸੂਚੀ ਦਿਓ।

ADR ਲਈ ਘੱਟੋ-ਘੱਟ ਇੱਕ ਸੰਬੰਧਿਤ, ਮਨਜ਼ੂਰ ਕੀਤਾ ਵਰਤੋਂ ਦਾ ਕੇਸ ਜ਼ਰੂਰੀ ਹੈ।

ਫਾਰਮੈਟ:

  • [ਵਰਤੋਂ ਦੇ ਕੇਸ ਦਾ ਨਾਮ](URL)

ਜੇ ADR ਕਿਸੇ ਵਰਤੋਂ ਦੇ ਕੇਸ ਦੀਆਂ ਸਾਰੀਆਂ ਲੋੜਾਂ ਨੂੰ ਸੰਬੋਧਿਤ ਨਹੀਂ ਕਰਦਾ, ਤਾਂ ਵਿਆਖਿਆ ਜੋੜੋ।

ਪ੍ਰਸੰਗ

ਵਰਣਨ ਕਰੋ:

  • ਡਿਜ਼ਾਈਨ ਆਰਕੀਟੈਕਚਰ ਪੱਖੋਂ ਮਹੱਤਵਪੂਰਨ ਕਿਵੇਂ ਹੈ - ਜੋ ADR ਦੀ ਲੋੜ ਪੈਦਾ ਕਰਦਾ ਹੈ (ਕਿਸੇ ਸਮੱਸਿਆ ਨੂੰ ਠੀਕ ਕਰਨ ਲਈ ਸਾਦੇ ਇਸ਼ੂ ਅਤੇ PR ਦੀ ਬਜਾਏ)

  • ਉੱਚ-ਪੱਧਰੀ ਡਿਜ਼ਾਈਨ ਪਹੁੰਚ (ਵੇਰਵੇ ਹੇਠਾਂ ਪ੍ਰਸਤਾਵਿਤ ਡਿਜ਼ਾਈਨ ਵਿੱਚ ਦੱਸੇ ਗਏ ਹਨ)

ਪ੍ਰਸਤਾਵਿਤ ਡਿਜ਼ਾਈਨ

ਡਿਜ਼ਾਈਨ ਦੇ ਵੇਰਵੇ (ਜਿੱਥੇ ਸੰਭਵ ਹੋਵੇ ਲਾਗੂਕਰਨ ਵਿੱਚ ਗਏ ਬਿਨਾਂ)।

ਰੂਪ-ਰੇਖਾ:

  • ਪ੍ਰਭਾਵਿਤ (ਬਦਲੀਆਂ ਜਾਣ ਵਾਲੀਆਂ) ਸੇਵਾਵਾਂ/ਮੌਡਿਊਲ

  • ਜੋੜੀਆਂ ਜਾਣ ਵਾਲੀਆਂ ਨਵੀਆਂ ਸੇਵਾਵਾਂ/ਮੌਡਿਊਲ

  • ਮਾਡਲ ਅਤੇ DTO ਉੱਤੇ ਪ੍ਰਭਾਵ (ਤਬਦੀਲੀਆਂ/ਵਾਧੇ/ਹਟਾਏ ਜਾਣਾ)

  • API ਉੱਤੇ ਪ੍ਰਭਾਵ (ਤਬਦੀਲੀਆਂ/ਵਾਧੇ/ਹਟਾਏ ਜਾਣਾ)

  • ਆਮ ਸੰਰਚਨਾ ਉੱਤੇ ਪ੍ਰਭਾਵ (ਨਵੇਂ ਭਾਗਾਂ ਦੀ ਸਥਾਪਨਾ, ਤਬਦੀਲੀਆਂ/ਵਾਧੇ/ਹਟਾਏ ਜਾਣਾ)

  • devops ਉੱਤੇ ਪ੍ਰਭਾਵ

ਵਿਚਾਰਨਯੋਗ ਗੱਲਾਂ

ADR ਦੀ ਬਹਿਸ ਦੌਰਾਨ ਉੱਠੇ ਵਿਕਲਪ, ਚਿੰਤਾਵਾਂ, ਸਹਾਇਕ ਜਾਂ ਸੰਬੰਧਿਤ ਮਸਲੇ ਅਤੇ ਸਵਾਲ ਦਰਜ ਕਰੋ।

ਦੱਸੋ ਕਿ ਉਨ੍ਹਾਂ ਦਾ ਹੱਲ ਜਾਂ ਨਰਮੀ ਕਿਵੇਂ ਹੋਈ, ਜੇ ਹੋਈ।

ਫੈਸਲਾ

ਸਹਿਮਤੀ ਨਾਲ ਤੈਅ ਹੋਏ ਕਿਸੇ ਵੀ ਮਹੱਤਵਪੂਰਨ ਲਾਗੂਕਰਨ ਵੇਰਵੇ, ਸ਼ਰਤਾਂ, ਭਵਿੱਖ ਦੇ ਵਿਚਾਰ, ਬਾਕੀ ਜਾਂ ਮੁਲਤਵੀ ਡਿਜ਼ਾਈਨ ਮਸਲੇ ਦਰਜ ਕਰੋ।

ਲੋੜਾਂ ਦਾ ਕੋਈ ਵੀ ਹਿੱਸਾ ਜੋ ਪ੍ਰਸਤਾਵਿਤ ਡਿਜ਼ਾਈਨ ਨਾਲ ਪੂਰਾ ਨਹੀਂ ਹੁੰਦਾ, ਉਸ ਨੂੰ ਦਰਜ ਕਰੋ।

ਹੋਰ ਸੰਬੰਧਿਤ ADR

ਕੋਈ ਵੀ ਸੰਬੰਧਿਤ ADR ਦੀ ਸੂਚੀ ਦਿਓ - ਜਿਵੇਂ ਕਿ ਕਿਸੇ ਵਿਸ਼ੇਸ਼ਤਾ ਦੇ ਉਪ-ਕੰਪੋਨੈਂਟ ਦਾ ਡਿਜ਼ਾਈਨ ਫੈਸਲਾ, ਇਸ ਡਿਜ਼ਾਈਨ ਦੇ ਨਤੀਜੇ ਵਜੋਂ ਅਪ੍ਰਚਲਿਤ ਹੋਇਆ ਡਿਜ਼ਾਈਨ, ਆਦਿ।

ਫਾਰਮੈਟ:

  • [ADR ਦਾ ਸਿਰਲੇਖ](URL) - ਸੰਬੰਧ

ਹਵਾਲੇ

ਵਾਧੂ ਹਵਾਲਿਆਂ ਦੀ ਸੂਚੀ ਦਿਓ।

ਫਾਰਮੈਟ:

  • [ਸਿਰਲੇਖ](URL)