انتقل إلى المحتوى
أمين أبوزيد
Englishالعربية
ARC-043

توثيق الحلول

  • 5 درس
  • 3 ساعة تدريب (تقدير)
ابدأ الوحدة
في هذه الصفحة 9 موضوعات

نص الدروس والتمارين باللغة الإنجليزية، بينما تبقى واجهة الموقع وعناوين الدروس بالعربية.

نظرة عامة

الموضوعات

  • حزم المعمارية
  • سجلات القرارات
  • الافتراضات
  • المخاطر

تعلّم أولًا

3 ساعة تدريب (تقدير)

مخرجات التعلم

  1. Assemble an architecture pack that serves executives, reviewers, delivery, and operations.
  2. Maintain a decision log, assumptions log, and risk register.
  3. Keep documentation current through delivery with clear ownership.
  4. Hand over documentation to operations and future architects.

الدروس

  1. 01حزمة المعمارية
  2. 02سجلات القرارات والافتراضات
  3. 03سجلات المخاطر
  4. 04إبقاء التوثيق حيًا
  5. 05عرض عملي: تجميع حزمة معمارية Larkspur

المختبر والتمارين

Lab

ARC-043-LAB1 · Larkspur architecture pack

Outcomes: 1–4 · Time: ~3 h

  1. Create the pack index with reader, owner, status, and version for each document.
  2. Write the one-page executive summary.
  3. Compile the decision log (at least five decisions), assumption log (at least five), and risk register (at least six) with owners and dates.
  4. Define ownership and update triggers for each document and a handover reading order for operations and a future architect.
  5. Have a role-played new architect answer ten questions using the pack alone; fix any gaps.

Acceptance: a role-played new architect answers ten questions using the pack alone.

Exercises (case-based; five exercises)

IDOutcomeTask
ARC-043-EX011Larkspur has a 120-page "solution document" that every group has stopped reading. Propose a pack structure by audience.
ARC-043-EX022Write a decision log entry for choosing a managed payment page and an assumption entry about a payment provider capability.
ARC-043-EX032Rewrite the risk "ERP integration problems" as an actionable register entry.
ARC-043-EX043Define update triggers and owners for HLD, LLD, risk register, and deployment diagram, and a check that catches stale documents.
ARC-043-EX054Plan the handover of the pack to operations and a successor architect: reading order, open items, and a verification step.
أظهر الحلول
  • EX01 Index and one-page summary; executive section (decision, value, risks, ask); reviewer section (HLD, ADRs, compliance); delivery section (LLD, contracts); operations section (deployment, runbooks, monitoring); each linked and owned.
  • EX02 Decision: context (card data scope), options, choice, consequences, owner, date. Assumption: capability statement, owner, confirm-by date, link to the decision it supports.
  • EX03 "Because the ERP vendor releases monthly, a changed stock API may break order promises; likelihood, impact, owner, mitigation (contract tests, change notice), trigger, review date."
  • EX04 HLD: owned by the architect, updated on any significant change or ADR; LLD: owned by the tech lead, updated per release; risk register: owner per risk, reviewed monthly; deployment diagram: owned by operations lead, updated on infrastructure change; health check compares documents with deployed reality at phase boundaries.
  • EX05 Reading order: summary, decision log, HLD, deployment, operations handover, risks; open decisions and risks listed with owners; verification: the successor answers a set of questions from the pack alone.

All four outcomes are also covered by the lab acceptance and the quiz.

Workplace evidence: an architecture pack you maintained through delivery.

الاختبار

Outcomes: O1 architecture pack · O2 decision, assumption, and risk logs · O3 keeping documentation current · O4 handover.

اختبار ذاتي لك: لا توجد درجات، ولا يُحفظ أو يُرسل أي شيء. اختر إجابة ثم تحقق منها، ويمكنك المحاولة مرة أخرى كما تشاء.

  1. 1Executives, reviewers, delivery teams, and operations all ask for "the document". The best response is:O1
  2. 2A pack document without an owner, status, or date is:O1
  3. 3What belongs in a decision log entry?O2
  4. 4How does an assumption differ from a decision?O2
  5. 5Which risk entry is actionable?O2
  6. 6A risk register where entries have no owners or dates:O2
  7. 7A good trigger for updating the HLD is:O3
  8. 8Which approach keeps documentation current?O3
  9. 9How do you test whether the handover pack works?O4
  10. 10A handover to operations should especially include:O4

الجزء العملي

Pack review on the Larkspur lab: a pack structured by audience with decision log, assumptions, and risk register, plus the ten-question new-architect test. Pass: quiz at least 8/10, at least four of five exercises correct, and a lab pack from which the new architect answers all ten questions (gaps found are fixed and retested).

أخطاء شائعة

One document for every audience; risk registers without owners or dates.

التقييم

Pack review.

دليل من بيئة العمل

An architecture pack you maintained through delivery.

الصلة بالمسار الوظيفي

Documentation is the lasting record of an architect's decisions.

اكتب للبحث في المستويات والمراحل والوحدات والدروس.