Fresher BA tham khảo quan điểm của các bạn Dev về SRS

Xin chào các anh chị và các bạn,

Mình là fresher BA, mình đang tham gia viết tài liệu cho dự án công ty, mà hay nghe anh tester góp ý là viết dài dòng quá, anh phải tự tóm tắt lại tài liệu theo cách anh í hiểu :frowning: (

Mình muốn tham khảo các anh chị và các bạn Dev là theo mọi người, để BA viết tài liệu SRS mà khi đến tay mọi người, mọi người thấy thích đọc, dễ đọc, đễ hiểu, đúng, đủ, thì BA nên học và nghiên cứu thêm những gì?

Cảm ơn cả nhà rất nhiều!

1 Like

Hi there,
Cậu khá cầu thị đấy chứ? :smile:

Cậu có thể theo các tips dưới đây để có thể viết ngắn gọn và dễ hiểu:

  • Cậu phải hiểu thực sự business requirement.
    Cậu có thể để ý, những người nói dễ hiểu nhất là những người hiểu rõ vấn đề nhất, chứ không phải vì vấn đề đơn giản. Khi cậu hiểu nó, cậu chỉ cần diễn đạt theo ngôn ngữ tự nhiên của cậu là đủ.
  • Cậu nên học cách chia nhỏ các tài liệu, mỗi tài liệu giải thích một vấn đề.
    Đi kèm với nó, cậu cũng nên học cách tổng hợp tài liệu sao cho dễ tìm kiếm bởi mọi người. Reference tới các tài liệu liên quan cũng là một cách tốt để cậu quản lý.
    Việc này sẽ tốn nhiều công sức hơn, nhưng bù lại, việc tìm kiếm thông tin sẽ hiệu quả hơn.
  • Cậu nên sử dụng nhiều bullet point thay vì đoạn văn dài.
    Cố gắng sử dụng các khoảng trống để tài liệu thoáng hơn.
  • Cậu nên sử dụng nhiều header để định nghĩa bố cục của tài liệu. Cố gắng để bố cục tài liệu hợp logic.
    Chẳng hạn, title của bài viết cậu có thể dùng title hoặc header 1, các mục chính để header 2, các mục phụ để header bé hơn.
    Header này cũng sẽ giúp cậu tạo table of contents dễ dàng hơn.
  • Cậu cũng có thể cân nhắc in đậm, in nghiêng, hoặc đổi màu text những đoạn cần được nhấn mạnh. Chẳng hạn với một kết luận quan trọng nào đó.
    Đừng lạm dụng nó quá là được :smile:
  • Cậu cũng có thể cân nhắc sử dụng bảng biểu, hoặc hình ảnh trực quan, để mô tả.
    Một hình ảnh tốt hơn ngàn lời nói:smile:
  • Cậu nên học cách trình bày trực tiếp vào vấn đề.
    Thường, trong industry, cậu có xu hướng đưa ra point chính, rồi giải thích point đó cùng với các ví dụ (diễn dịch). Cậu không nên dùng “quy nạp” hay “tổng phân hợp” khi viết tài liệu, trừ khi cậu biết cậu đang làm gì.
  • Nếu cậu đã làm được những điều trên, mà có người còn phàn nàn tài liệu khó hiểu, cậu nên hỏi họ có suggest gì, hay có practice gì mà họ nghĩ sẽ có ích hay không trong TH cụ thể.
    Nếu họ nói được, thì tốt, cậu nên lắng nghe.
    Nếu họ chỉ nói mơ hồ, chung chung, thì cậu có thể hiểu là họ cũng không biết họ đang làm gì. Đó là vấn đề của họ, không phải của cậu.

Cố gắng giữ sự cầu thị đó nhé!

5 Likes

Cảm ơn cậu rất nhiều vì câu trả lời đầy tâm huyết!

Rất chi tiết và hữu ích!

Tớ đã note lại hết hehee. Nhiều cái có thể áp dụng và xài được ngay cậu ạ.

Tớ vẫn còn băn khoăn, muốn tham khảo thêm về cách rèn luyện tư duy hàng ngày: nên rèn thế nào để làm được tài liệu tốt nhỉ? :smiley:

1 Like

:smile:

Có vẻ cậu nhận được lời khuyên nào đó của một người thế hệ trước về việc “cải thiện tư duy” :smile:
“Tư duy” là một từ trừu tượng, và “viết tài liệu” là một điều tổng quát. Sẽ thế nào nếu tớ cho cậu một số lời khuyên tổng quát về “mindset” khi viết tài liệu kỹ thuật/đặc tả thông thường? :smile:
Mindset sẽ định hướng cho cậu cách suy nghĩ, nhìn nhận việc viết tài liệu đặc tả. Từ đó, với cách tiếp cận phù hợp và sự luyện tập theo hướng suy nghĩ ở trên, cậu nên sớm học được cách viết tài liệu đủ tốt.
Tớ nghĩ nó sẽ thực tiễn hơn cho cậu.

Về mindset:

  • Công việc viết tài liệu, đặc biệt là tài liệu đặc tả, cần sự tỉ mỉ và tốn nhiều công sức.
    Vì vậy, cậu không nên kỳ vọng cậu có thể làm nó nhanh, đặc biệt là thời điểm đầu.
  • Tài liệu đặc tả nói chung cần được viết rất chi tiết và chặt chẽ, để loại bỏ sự nhập nhằng hay khả năng hiểu nhầm.
    Nói cách khác, cậu không nên kỳ vọng viết một thứ trừu tượng, hoặc ngắn gọn quá mà tất cả mọi người đều hiểu ý.
  • Tài liệu đặc tả được viết hướng tới đối tượng có hiểu biết nhất định về cả kỹ thuật lẫn phần mềm cơ bản, thậm chí cả business terminology cơ bản nhất.
    Vậy nên, cậu không nhất thiết phải giải thích những thứ quá cơ bản, những thứ được presume đã được giải thích ở trường lớp trong từng tài liệu. Cậu có thể tạo một tài liệu “Glossary” nói chung để mọi người dễ dàng hiểu các thuật ngữ trong project. Như vậy, cậu sẽ có thời gian tập trung vào giải thích những đặc tả quan trọng, và bớt thời gian viết những đoạn tài liệu vô bổ.
    Điều này cũng đồng nghĩa với việc cậu phải hiểu và sử dụng chính xác các thuật ngữ kể trên.
  • Tài liệu là thứ nên được thiết kế để dễ tìm thông tin nhất có thể bởi tất cả các thành viên.
    Nếu cậu không thể search được tài liệu hiệu quả, dù cậu viết tốt như thế nào cũng khó mang lại hiệu quả cao.

Sau khi cậu có được mindset phù hợp về việc viết tài liệu, tớ hi vọng cậu sẽ có hướng suy nghĩ và làm việc tốt hơn, và ít thời gian “lạc lối” (hay bối rối) hơn. Việc luyện tập gì và luyện tập như thế nào, tớ nghĩ cậu đã trả lời được, vì cậu là chuyên gia về bản thân cậu mà :smile:

3 Likes

Cảm ơn cậu rất nhiều!

1 Like
83% thành viên diễn đàn không hỏi bài tập, còn bạn thì sao?