Điều tra lỗi
Thu thập nhật ký lỗi, giả thuyết, câu lệnh và các bước giải quyết trong một ghi chú duy nhất.
- Đầu ra lỗi
- Các giải pháp đã thử
- Kết quả và theo dõi
Kịch bản
Các trường hợp sử dụng cho đội ngũ nhà phát triển
Từ các dự án cá nhân đến các nhóm nhỏ, không gian ghi chú nhanh là cần thiết để kiến thức kỹ thuật luôn được tổ chức ngăn nắp.
Phân loại lỗi
Bản ghi quyết định kỹ thuật
Lưu trữ đoạn mã và tài nguyên
Bản ghi quyết định kỹ thuật
Làm cho các quyết định, phương án thay thế và lý do trở nên dễ tìm lại.
- Tóm tắt quyết định
- Các phương án thay thế
- Lý do và rủi ro
Cơ sở kiến thức cá nhân
Giữ cho các câu lệnh thường dùng, đoạn mã và liên kết luôn ngăn nắp.
- Sổ tay câu lệnh
- Các đoạn mã nguồn
- Liên kết tài nguyên
Phân loại lỗi
Các cuộc điều tra lỗi rải rác được thu gọn vào một ghi chú duy nhất có thể theo dõi.
Khi làm việc với một lỗi, đầu ra terminal, liên kết ảnh chụp màn hình, câu lệnh đã thử và các giả thuyết ngắn thường nằm rải rác ở nhiều nơi khác nhau. MDNote.dev thu thập các bản ghi nhỏ này vào cùng một ghi chú Markdown.
- Viết rõ ràng các điều kiện xảy ra lỗi
- Liệt kê các giải pháp đã thử
- Phân tách giải pháp thực tế khi hoàn thành
Ký ức quyết định
Các quyết định kỹ thuật nhỏ trở thành ký ức dự án lớn theo thời gian.
Không phải mọi quyết định đều cần một định dạng ADR chính thức. Nhưng nếu lý do chọn một thư viện, endpoint nào đã thay đổi hoặc tại sao thực hiện giải pháp tạm thời được ghi lại, nhóm sẽ ít gặp phải sự lặp lại hơn.
- Phân tách quyết định và lý do
- Giữ các phương án thay thế ngắn gọn
- Bảo tồn phần cốt lõi mà sau này sẽ chuyển sang tài liệu chính thức
Trường hợp sử dụng này đặc biệt giúp giảm thiểu việc mất ghi chú sau cuộc họp trong các nhóm nhỏ.
Luồng công việc thực tế
MDNote.dev thêm giá trị vào đâu trong công việc hàng ngày?
Điểm chung của các kịch bản này là thông tin được viết nhanh chóng và có thể tìm lại dễ dàng sau đó.
Nghiên cứu API
Hành vi của endpoint, payload mẫu và phản hồi lỗi được lưu trữ ngăn nắp.
Chuẩn bị phát hành
Ghi chú thay đổi, rủi ro và các mục danh sách kiểm tra được tập hợp trong một bản nháp.
Nhật ký học tập
Các thư viện mới, câu lệnh hoặc quyết định kiến trúc trở thành tài liệu tham khảo cá nhân theo thời gian.
Lưu trữ đoạn mã
Các đoạn mã nguồn thường xuyên lặp lại được lưu trữ cùng với giải thích của chúng.
FAQ
Câu hỏi về các kịch bản
MDNote.dev có nên thay thế wiki của nhóm không?
Đối với các tài liệu chính thức và lâu dài, một wiki hoặc tài liệu kho lưu trữ có thể phù hợp hơn. MDNote.dev linh hoạt hơn cho việc ghi chép nhanh, chuẩn bị cá nhân và ký ức của nhóm nhỏ.
Những ghi chú nào nên đưa vào thư mục, những ghi chú nào nên đưa vào thẻ tag?
Thư mục đại diện cho ngữ cảnh chính; như dự án hoặc khách hàng. Thẻ tag mang các chủ đề lặp lại trên nhiều thư mục khác nhau.
Nó có phù hợp để chuẩn bị ghi chú phát hành không?
Có. Đầu tiên bạn có thể thu thập các thay đổi dưới dạng bản nháp Markdown, sau đó chuyển chúng sang tài liệu sản phẩm hoặc định dạng nhật ký thay đổi (changelog).
Chọn một kịch bản
Mở ghi chú đầu tiên của bạn cho một nhiệm vụ thực tế.
Lựa chọn một chủ đề cụ thể như điều tra lỗi, kiểm thử API hoặc ghi lại quyết định sẽ giúp thấy rõ giá trị của MDNote.dev nhanh hơn.