DEV Community

Long Nguyễn Xuân
Long Nguyễn Xuân

Posted on • Edited on

2

Kho tài liệu dự án (cả docs và code)

Khi làm việc trong dự án thì tuyệt đối không có chuyện "em để tài liệu trên laptop ạ", vì nó sẽ giống cái hình bên dưới 😜

nhưng mà chuyện lỡ tay gạt licafe vào laptop hoặc trọ bị trộm viếng, nó bưng cái laptop 💻 đi là có thật 🤐

cho nên, khi bắt đầu làm dự án, thì lập tức tạo 2 cái

  1. code repository (code repo): có thể dùng github, gitlab, bitbucket, azure board whatever...
  2. document repostiory (docs repo): có thể dùng Google Drive, Onedrive, Dropbox, whatever...

cấp quyền cho tất cả thành viên truy cập.

với code repository, nếu xịn, hãy tìm hiểu về git flowCI/CD và áp dụng vào dự án, nếu không thì cứ code xong push lên rồi merge request là được, đã thực sự dùng git thì "không mất" code được đâu, nó bị "đè" thôi, xử lý issue vài lần là quen 😎

với docs repo, thì tạo theo cấu trúc sau

01-WIP          # trong này để toàn bộ tài liệu "đang làm dang dở" 
02-Templates    # trong này là các templates để làm việc với dự án đó,
                # trong doanh nghiệp thì nó là template của công ty 
                # và khách hàng, trong trường thì nó là template trường 
                # quy định. 
03-Review       # folder chứa các tài liệu được __copy__ từ WIP sang 
                # để mentor / sếp / khách hàng review 
04-References   # tài liệu tham khảo, có thể là đồ án điểm cao của 
                # mùa trước, hoặc file pdf chứa những kiến thức 
                # cần members học trong dự án này 
05-Baselined    # chứa tài liệu "bản đẹp", nếu như là dự án dài hơi 
                # nơi mà mình sẽ chứa những tài liệu "đã được duyệt" 
                # việc thay đổi đối với các tài liệu này sẽ là 
                # "change request", một thứ đáng sợ sẽ học sau 
99-Others       # tất cả những thứ còn lại không nhét được 
                # vào 4 folder trên. 
Enter fullscreen mode Exit fullscreen mode

trong quá trình làm dự án, thằng nào "tao để tài liệu trên laptop" thì đấm 👊🥴 nó ngay là vừa, đừng để tới ngày chuẩn bị bảo vệ đồ án thì nó bảo "laptop tau bị hư rồi" và cả nhóm sẽ phải thức trắng đêm soạn lại

Image description

Image of Timescale

🚀 pgai Vectorizer: SQLAlchemy and LiteLLM Make Vector Search Simple

We built pgai Vectorizer to simplify embedding management for AI applications—without needing a separate database or complex infrastructure. Since launch, developers have created over 3,000 vectorizers on Timescale Cloud, with many more self-hosted.

Read more →

Top comments (0)

Image of Docusign

🛠️ Bring your solution into Docusign. Reach over 1.6M customers.

Docusign is now extensible. Overcome challenges with disconnected products and inaccessible data by bringing your solutions into Docusign and publishing to 1.6M customers in the App Center.

Learn more

👋 Kindness is contagious

Engage with a sea of insights in this enlightening article, highly esteemed within the encouraging DEV Community. Programmers of every skill level are invited to participate and enrich our shared knowledge.

A simple "thank you" can uplift someone's spirits. Express your appreciation in the comments section!

On DEV, sharing knowledge smooths our journey and strengthens our community bonds. Found this useful? A brief thank you to the author can mean a lot.

Okay