Viết documentation cho project cá nhân mảng lập trình web

290 lượt xem

profile picture

Ẩn danh

Ngày 7 tháng 07 năm 2023

Chào mọi người ạ, em đang tìm hiểu việc viết documentation khi tự làm project cá nhân về mảng lập trình web. Mọi người có thể cho em biết là mình nên viết theo dàn ý như thế nào? Sử dụng công cụ nào để viết? Cần chú ý gì khi viết? Có cần viết quá trình mình làm dự án như thế nào kiểu theo ngày hoặc tuần không ạ? Em cảm ơn mọi người, mong mọi người có thể giải đáp giúp em ạ.

Đánh giá câu hỏi ngay!

Hãy ấn Up Vote với những câu hỏi cụ thể và chi tiết

Hãy ấn Down Vote với những câu hỏi chưa rõ ràng Careerly sẽ nhắc người hỏi chỉnh sửa lại.

1 câu trả lời

BEST

Ảnh đại diện của Kien Dinh

Chào bạn, một câu hỏi rất hay, để mình gợi ý bạn cách viết document cho dự án cá nhân cũng như có thể áp dụng cho công việc bạn làm được chuyên nghiệp hơn nhé. Khi chúng ta làm dự án thường coi nhẹ vấn đề viết document, nhưng chính document lại là một thành phần quan trọng giúp cho cả team về cả business lẫn developer các mảng như Backend, Frontend hay Mobile có thể hiểu rõ nghiệp vụ và làm việc thông suốt hơn. Chúng ta sẽ cần trả lời 2 câu hỏi: Cách trình bày nội dung thế nào, và sử dụng công cụ gì? 🍉 Trình bày như thế nào? Bạn có thể tách document thành 2 loại: - Document theo từng tính năng. - Document hướng dẫn config, coding…, thiên hướng kĩ thuật hơn. Về phần dàn ý, bạn tham khảo của mình: 1. Giới thiệu, nhằm đưa ra overview và cung cấp ngữ cảnh cho người đọc dễ tiếp cận mục sau. 1.1. Yêu cầu chức năng: Các chức năng chính của hệ thống cần làm như trả về thông tin, điểm số từ API… Nôm na chính là những tính năng mà end-user cần dùng. 1.2. Yêu cầu phi chức năng: Đại loại là những ràng buộc và tính chất của hệ thống, chẳng hạn trong 10h sáng tới 12h trưa số lượng người dùng đồng thời tăng đột biến, hệ thống phải đảm bảo hoạt động trơn tru và không được có độ trễ… 2. Approach - Hướng tiếp cận: Trình bày hướng xử lý, thường sẽ đưa các diagram vào để người đọc dễ hình dung hơn. 3. Implementation - Triển khai: Mục này trình bày chi tiết cách implement, chèn mẫu code lúc bạn viết, vân va và vân vân… 🍉 Xuất bản & Format Mình thì luôn recommend các bạn dev viết bằng markdown, vì định dạng này được hỗ trợ ở khắp nơi, cũng dễ dàng chỉnh sửa, chỉ bằng cái text editor là được. Bên cạnh đó bạn có thể sử dụng notion để viết, sau khi viết xong thì copy và paste lại sang bên markdown, cú pháp nó vẫn sẽ nhận. Ngoài ra bạn cũng có thể xuất bản luôn tài liệu của bạn lên web, lỡ ai đó thấy nó có ích thì sao? Tham khảo bài viết blog của mình: https://kiendinh.space/cach-viet-tai-lieu-ki-thuat-cho-developer/ Markdown cheatsheet: https://quickref.me/markdown Bài mình viết về notion: https://careerly.vn/comments/6441 Bài của anh Minh Monmen về cách làm side project: https://careerly.vn/comments/6594

Đăng ký ngay bây giờ để đọc toàn bộ câu trả lời!

Cộng đồng lập trình viên sẽ giải đáp tường tận cho bạn.

Xem thêm

Đồng ý với Điều khoản dịch vụ Chính sách bảo mật của Careerly

Bạn đã có tài khoản rồi?

Đăng ký ngay bây giờ để đọc toàn bộ câu trả lời!

Cộng đồng lập trình viên sẽ giải đáp tường tận cho bạn.