Tải lên tài liệu API, đổi danh, ghi chú tích hợp, biểu đồ kiến trúc, và tài liệu nhà phát triển khác để tạo ra video hiển thị các con đường yêu cầu, hành vi hệ thống, thay đổi phiên bản, và điểm đánh giá.
Hướng dẫn kỹ thuật
Cố gắng này
“Sử dụng Đánh giá MDN HTTP, giải thích chu kỳ cuộc sống yêu cầu HTTP từ cài đặt khách hàng thông qua phản ứng, caching và ranh giới thất bại.”
Hướng dẫn sử dụng Blueprint Breakdown
Cố gắng này
“Sử dụng @Atlas Scheduler v3 Hướng dẫn kiến trúc và phát hành, biến nguồn thành một giải thích rõ ràng cho các nhà phát triển và các nhà truyền thông kỹ thuật.”
Tải về dòng công việc Illustrative · Control Room Overview
Cố gắng này
“Sử dụng @Northstar Service Degradation Triage và Handoff Runbook, Chuyển nguồn thành một giải thích chi tiết về phòng kiểm soát cho các nhóm hoạt động CNTT.”
Bạn cần một giải thích cung cấp một hướng dẫn mới cho các nhà phát triển trước khi họ di chuyển trên bộ tài liệu đầy đủ.
Bạn muốn một sự thay đổi phát hành hoặc tích hợp trở nên dễ dàng hơn để giao tiếp giữa những người sở hữu các bộ phận khác nhau của hệ thống.
Chuẩn bị tài liệu của bạn
Chuyển đổi tài liệu nhà phát triển như API docs, biểu đồ kiến trúc, changelogs, và ghi chú tích hợp vào video mọi người có thể theo dõi và xem lại.
Một con đường tập trung
Đặt mục tiêu của nhà phát triển, mối quan hệ hệ thống mà họ cần hiểu, và phiên bản hiện tại hoặc giới hạn mà nó quan trọng.
Thêm nguồn hiện tại và đặt tên các phần, thuật ngữ, con số hoặc bước mà giải thích phải giữ.
Có API hoặc chủ sở hữu sản phẩm xác minh thuật ngữ, hành vi mẫu, tham chiếu phiên bản, và giới hạn an toàn nhạy cảm trước khi chia sẻ.
Thích hợp tiếp theo bước
Sử dụng một kịch bản được hỗ trợ nguồn để làm cho con đường kỹ thuật có thể nhìn thấy
Một hướng dẫn thực tế để biến các hướng dẫn kiến trúc, tài liệu nhà phát triển, và sách chạy IT thành video giải thích kỹ thuật rõ ràng.
Sử dụng tài nguyên này Template và checklistsMột mẫu kịch bản có thể sao chép 60 giây để giải thích một quá trình, quyết định, biểu đồ hoặc dòng công việc kỹ thuật với bằng chứng thị giác rõ ràng.
Sử dụng tài nguyên này Template hoạt độngMột mẫu có thể sao chép để biến một runbook IT thành một video yên tĩnh, cụ thể cho vai trò mà làm cho kiểm tra đầu tiên, đường đi và handoff rõ ràng.
Sử dụng tài nguyên này Nguồn nguồn hỗ trợXem cách một kiến trúc và hướng dẫn phát hành trở thành một nhà phát triển trên máy bay video kết nối các thành phần, dòng phát hành, và bối cảnh đóng góp.
Đọc Case Design Nguồn nguồn hỗ trợXem một trình duyệt giảm giá dịch vụ IT trở thành một video kiểm tra yên tĩnh cho thấy kiểm tra tình trạng, chủ sở hữu leo thang, và bản cập nhật tiếp theo cho các nhóm hoạt động.
Đọc Case Design