thắc mắc Công ty các bác viết tài liệu như nào giúp người mới dễ dàng tiếp cận?

Ruaconlonton123

Senior Member
Em đi làm (tính cả intern) được 4 chỗ rồi, 2 công ty đầu mà em intern thì là start up, nên cứ thế code, k có tí tài liệu nào cả, 2 công ty em làm fulltime thì dự án chạy ổn đỉnh, code được 3,4 năm rồi, nhưng không có tài liệu gì. Người mới chạy project từ đầu khổ dã man, với những dự án đã chạy lâu thì logic cũng nhiều, nhiều phần chỉ người code mới hiểu, maintain đống này cũng rất khổ.

Vậy, công ty các bác thực hiên việc viết tài liệu như nào để giúp người mới dễ dàng tiếp cận với dự án? Công ty các bác có chú trọng việc viết tài liệu không?
 

Boss Lacotes

Senior Member
toàn làm outsource , nên dựa vào yêu cầu của kh, là chính, tài liệu kh cũng đưa cho mà xem, cái nào ngon thì chi tiết cái nào ko ngon thì tự mò, còn chưa làm cái product nào thực sự to, nên tài liệu cũng toàn tự viết theo dạng mô tả lib thôi (kiểu gần giống như này : https://jauntium.com/javadocs/index.html)
 
Last edited:

Love U So Much

Senior Member
Tài liệu để quay bài à :/, ko có tài liệu liên quan tới code, nếu có cũng rất chung chung hoặc là docs cho third party dùng

Nếu có thì chỉ có nghiệp vụ phức tạp như bên ngân hàng có hẳn 1 phòng phân tích nghiệp vụ thì có

Vẫn là đọc code và hiểu thôi ạ. Ko có cái diagram nào đâu
 

khoahocphothong

Senior Member
1 trong 2 thứ tốn nhiều tiền nhất để làm là maintain documentation, nên thường các cty cắt bỏ, chủ yếu người sau vào thì người trước truyền miệng lại cho thôi :burn_joss_stick: may lắm thì có vài cái UML diagram giải thích flow
 

question21

Senior Member
Em đi làm (tính cả intern) được 4 chỗ rồi, 2 công ty đầu mà em intern thì là start up, nên cứ thế code, k có tí tài liệu nào cả, 2 công ty em làm fulltime thì dự án chạy ổn đỉnh, code được 3,4 năm rồi, nhưng không có tài liệu gì. Người mới chạy project từ đầu khổ dã man, với những dự án đã chạy lâu thì logic cũng nhiều, nhiều phần chỉ người code mới hiểu, maintain đống này cũng rất khổ.

Vậy, công ty các bác thực hiên việc viết tài liệu như nào để giúp người mới dễ dàng tiếp cận với dự án? Công ty các bác có chú trọng việc viết tài liệu không?
Mấy công ty mà lớn họ thường yêu cầu chuẩn bị kỹ tài liệu trước khi code, hoặc sau khi code xong. Cái đấy còn review kỹ nữa. Nhưng được cái là sau này ngừoi mới vào thì quá trình onboard thuận lợi hơn, với dễ maintain
 

nhân vật phụ

Junior Member
may mắn là cty cũ mình làm product luôn bắt viết doc đầy đủ. dù mỗi ông viết 1 kiểu, copy chắp vá tùm lum nhưng mà có vẫn còn hơn không
yBBewst.png
 

codeforfood2015

Senior Member
Tài liệu để quay bài à :/, ko có tài liệu liên quan tới code, nếu có cũng rất chung chung hoặc là docs cho third party dùng

Nếu có thì chỉ có nghiệp vụ phức tạp như bên ngân hàng có hẳn 1 phòng phân tích nghiệp vụ thì có

Vẫn là đọc code và hiểu thôi ạ. Ko có cái diagram nào đâu

về VND đi :)) giờ documents ngon nhất thị trường luôn (thấy chém vậy)
 

Xiao_man_tau

Senior Member
Documents với dev thì chỉ cần 2 cái: một là setup (hầu như viết 1 lần) hai là api schema (có thể auto updated).
Còn lại thì nice to have, chủ yếu phía manager bảo trì đống tài liệu business này, anh em dev rảnh đọc cho hiểu sản phẩm.
 

xuansang999

Senior Member
chỉ có tài liệu nghiệp vụ do bên trên đưa xuống còn lại đọc code tự suy ra cái nào ko hiểu đập code lại :shame:
 

TheSun89

Junior Member
Kinh nghiệm cho thấy khi bắt đầu một dự án phải viết kiến trúc của ứng dụng đã, sau đó là tài liệu các chức năng của ứng dụng. Mà trước tiên phải thông não là cái đó mục đích để làm gì cuối cùng chốt "Nghiệp vụ".
 

hikaruu

Junior Member
Phân theo folder, cấu trúc product nhé, nhìn cái biết folder đó làm gì, hay file đó làm gì là ok
VD: componentA.js, componentA.style.js,componentA.strings.en.json,componentA.strings.fr.json,... Nhìn cái là biết các file đó nó thuộc về nhau rồi và làm chức năng gì
 
Top